This is a simple call to check if you have access to the MyCumulus back-end.
GET /v1/online
{
"status" : 200,
"uri" : "/v1/online",
"server_status" : {
"status" : true
}
}
Returns the version of the MyCumulus API and of the back-end software.
GET /v1/version
{
"status" : 200,
"uri" : "/v1/version",
"version" : {
"api_version" : "5.2",
"backend_version" : "5.2.0"
}
}
This command verifies if the client software using the given API version is compatible with the actual API version. In the response, client_version_compatible is true if the back-end is backwards compatible with the API used by the client.
GET /v1/version/4.3
{
"status" : 200,
"uri" : "/v1/version/4.3",
"version" : {
"client_version_compatible" : true,
"client_version" : "4.3",
"api_version" : "5.2",
"backend_version" : "5.2.0"
}
}
Returns the actual UTC time of the MyCumulus back-end. The back-end server uses the Amazon Time Sync Service for time syncronisation.
GET /v1/time
{
"status" : 200,
"uri" : "/v1/time",
"time" : "2023-08-19T11:26:07.060735Z"
}
Returns for Lambert 72 (B), Lambert 2008 (B) and RD (NL), the difference between ellipsoidal height and orthometric height.
POST /v1/crs/dz
Content-Type: application/json
X-Auth-Token: 25597eae24e727a5b33d42ca6413ecf0d54d2392a3ac5a81abb352ca3b7eadf869b3d5270368b70b2d4bf3da6d4746176312383be568cf57e32f48d6a3e32cff1747744cf6ea424f19f61a4e273c645f712d449e0c8705c3edfed1c5ed1d0458f4151f5d1664a6c7f10178ffb29b3239feb29aea1367c516b607716f
{
"crs" : "RDNAP",
"coordinates" : {
"latitude" : 51.7010500000000,
"longitude" : 5.35511000000000
}
}
{
"Z_value" : {
"Z" : 43.588318565505986
},
"uri" : "/v1/crs/dz",
"status" : 200
}
Converts from geodetic to plane coordinates.
- Lambert 72 (B) and Lambert 2008 (B) : ellipsoidal altitude is converted to TAW.
- RD (NL) : ellipsoidal altitude is converted to NAP.
- BGS2005 : heigth = ellipsoidal altitude. Converts to Bulgarian CRS BGS2005 Cadastral.
- UTM : heigth = ellipsoidal altitude. The conversion is automatically done in the UTM zone of the given latitude, longitude.
See also:
Utilities - Convert list of Geodetic Coordinates to Plane Coordinates
Utilities - Convert Plane Coordinates to Geodetic Coordinates
Utilities - Convert list of Plane Coordinates to Geodetic Coordinates
POST /v1/crs/conversion
Content-Type: application/json
X-Auth-Token: 25597eae24e727a5b33d42ca6413ecf0d54d2392a3ac5a81abb352ca3b7eadf869b3d5270368b70b2d4bf3da6d4746176312383be568cf57e32f48d6a3e32cff1747744cf6ea424f19f61a4e273c645f712d449e0c8705c3edfed1c5ed1d0458f4151f5d1664a6c7f10178ffb29b3239feb29aea1367c516b607716f
{
"crs" : "RDNAP",
"coordinates" : {
"latitude" : 51.7010500000000,
"longitude" : 5.35511000000000,
"altitude" : 47.1230000000000
}
}
{
"coordinates" : {
"X" : 152781.5616310775,
"Y" : 412476.39033625706,
"Z" : 3.5346814344940114
},
"uri" : "/v1/crs/conversion",
"status" : 200
}
Converts a list of geodetic coordinates to plane coordinates.
See also:
Utilities - Convert Geodetic Coordinates to Plane Coordinates
Utilities - Convert Plane Coordinates to Geodetic Coordinates
Utilities - Convert list of Plane Coordinates to Geodetic Coordinates
POST /v1/crs/listconversion
Content-Type: application/json
X-Auth-Token: 25597eae24e727a5b33d42ca6413ecf0d54d2392a3ac5a81abb352ca3b7eadf869b3d5270368b70b2d4bf3da6d4746176312383be568cf57e32f48d6a3e32cff1747744cf6ea424f19f61a4e273c645f712d449e0c8705c3edfed1c5ed1d0458f4151f5d1664a6c7f10178ffb29b3239feb29aea1367c516b607716f
{
"crs" : "Lambert72",
"coordinates" : [
{
"latitude" : 51.0000000000000,
"longitude" : 5.00000000000000,
"altitude" : 75.0000000000000
},
{
"latitude" : 51.1000000000000,
"longitude" : 5.10000000000000,
"altitude" : 75.1000000000000
},
{
"latitude" : 51.2000000000000,
"longitude" : 5.20000000000000,
"altitude" : 75.2000000000000
}
]
}
{
"coordinates" : [
{
"X" : 194310.43337177983,
"Y" : 187941.78858876982,
"Z" : 31.97233327229818
},
{
"X" : 201220.15400326814,
"Y" : 199130.4603034103,
"Z" : 32.3336680094401
},
{
"X" : 208099.7824498453,
"Y" : 210328.6867683348,
"Z" : 32.76499862670899
}
],
"uri" : "/v1/crs/listconversion",
"status" : 200
}
Converts from plane coordinates to geodetic coordinates.
For more details about the supported CRS's see Utilities - Convert Geodetic Coordinates to Plane Coordinates
See also:
Utilities - Convert Geodetic Coordinates to Plane Coordinates
Utilities - Convert list of Geodetic Coordinates to Plane Coordinates
Utilities - Convert list of Plane Coordinates to Geodetic Coordinates
POST /v1/crs/inverse_conversion
Content-Type: application/json
X-Auth-Token: 25597eae24e727a5b33d42ca6413ecf0d54d2392a3ac5a81abb352ca3b7eadf869b3d5270368b70b2d4bf3da6d4746176312383be568cf57e32f48d6a3e32cff1747744cf6ea424f19f61a4e273c645f712d449e0c8705c3edfed1c5ed1d0458f4151f5d1664a6c7f10178ffb29b3239feb29aea1367c516b607716f
{
"crs" : "RDNAP",
"coordinates" : {
"X" : 152781.563000000,
"Y" : 412476.389000000,
"Z" : 3.55000000000000
}
}
{
"location" : {
"altitude" : 47.138318575872425,
"latitude" : 51.70104998838578,
"longitude" : 5.35511002040349
},
"uri" : "/v1/crs/inverse_conversion",
"status" : 200
}
Converts a list of plane coordinates to geodetic coordinates.
See also:
Utilities - Convert Geodetic Coordinates to Plane Coordinates
Utilities - Convert Plane Coordinates to Geodetic Coordinates
Utilities - Convert list of Geodetic Coordinates to Plane Coordinates
POST /v1/crs/list_inverse_conversion
Content-Type: application/json
X-Auth-Token: 25597eae24e727a5b33d42ca6413ecf0d54d2392a3ac5a81abb352ca3b7eadf869b3d5270368b70b2d4bf3da6d4746176312383be568cf57e32f48d6a3e32cff1747744cf6ea424f19f61a4e273c645f712d449e0c8705c3edfed1c5ed1d0458f4151f5d1664a6c7f10178ffb29b3239feb29aea1367c516b607716f
{
"crs" : "Lambert72",
"coordinates" : [
{
"X" : 194310.433000000,
"Y" : 187941.789000000,
"Z" : 31.9720000000000
},
{
"X" : 201220.154000000,
"Y" : 199130.460000000,
"Z" : 32.3340000000000
},
{
"X" : 208099.782000000,
"Y" : 210328.684000000,
"Z" : 32.7650000000000
}
]
}
{
"locations" : [
{
"altitude" : 74.99966672373188,
"latitude" : 51.000000001884075,
"longitude" : 5.000000005450774
},
{
"altitude" : 75.10033200234022,
"latitude" : 51.0999999954506,
"longitude" : 5.10000001060911
},
{
"altitude" : 75.20000145388698,
"latitude" : 51.19999997335334,
"longitude" : 5.200000003755887
}
],
"uri" : "/v1/crs/list_inverse_conversion",
"status" : 200
}
Upload GNSS location. Stores the most recent GNSS location of the user. Can be used for track and trace.
POST /v1/location/upload
Content-Type: application/json
X-Auth-Token: 55f5e7ffeaa93b82725d2adca10824dfe95825d99389820fce26f86fc862d0fa3939ed76ce7d89b2ddee1cb026cf9845e06cba2b81dfd8943a307991447e3484807ec445ba6a4ddffcbe96f7fad391da91a5b4c9dcea3afb174341a4930cd7fe08ea4d19ecabe88de6a87d6c8471ec393a2acdcf33d7ad7ee95f
{
"user_id" : "64e0a6cf70a5f601e6d3ac70",
"user_name" : "DrPyth",
"gnss_source" : "MyCumulus GNSS",
"coordinates" : {
"longitude" : 51.7010500000000,
"latitude" : 5.35511000000000,
"altitude" : 66.2390000000000,
"accuracy" : 1.30000000000000E-3
}
}
{
"location" : {
"id" : "64e0a6cf70a5f601e6d3ac77",
"created_at" : "2023-08-19T11:26:07.876318Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6cf70a5f601e6d3ac70",
"updated_by" : null,
"deleted_by" : null,
"user_id" : "64e0a6cf70a5f601e6d3ac70",
"coordinates" : {
"latitude" : 5.35511,
"longitude" : 51.70105,
"altitude" : 66.239,
"accuracy" : 0.0013
},
"user_name" : "DrPyth",
"gnss_source" : "MyCumulus GNSS"
},
"uri" : "/v1/location/upload",
"status" : 200
}
Gets the most recent GNSS location.
GET /v1/location/64e0a6cf70a5f601e6d3ac70
X-Auth-Token: 55f5e7ffeaa93b82725d2adca10824dfe95825d99389820fce26f86fc862d0fa3939ed76ce7d89b2ddee1cb026cf9845e06cba2b81dfd8943a307991447e3484807ec445ba6a4ddffcbe96f7fad391da91a5b4c9dcea3afb174341a4930cd7fe08ea4d19ecabe88de6a87d6c8471ec393a2acdcf33d7ad7ee95f
{
"location" : {
"latitude" : 5.35511,
"longitude" : 51.70105,
"altitude" : 66.239,
"accuracy" : 0.0013
},
"uri" : "/v1/location/64e0a6cf70a5f601e6d3ac70",
"status" : 200
}
Deletes the GNSS location.
DELETE /v1/location/64e0a6cf70a5f601e6d3ac70
X-Auth-Token: 55f5e7ffeaa93b82725d2adca10824dfe95825d99389820fce26f86fc862d0fa3939ed76ce7d89b2ddee1cb026cf9845e06cba2b81dfd8943a307991447e3484807ec445ba6a4ddffcbe96f7fad391da91a5b4c9dcea3afb174341a4930cd7fe08ea4d19ecabe88de6a87d6c8471ec393a2acdcf33d7ad7ee95f
{
"location" : {
"id" : "64e0a6cf70a5f601e6d3ac77",
"created_at" : "2023-08-19T11:26:07.876Z",
"updated_at" : null,
"deleted_at" : "2023-08-19T11:26:07.938210Z",
"created_by" : "64e0a6cf70a5f601e6d3ac70",
"updated_by" : null,
"deleted_by" : null,
"user_id" : "64e0a6cf70a5f601e6d3ac70",
"coordinates" : {
"latitude" : 5.35511,
"longitude" : 51.70105,
"altitude" : 66.239,
"accuracy" : 0.0013
},
"user_name" : "DrPyth",
"gnss_source" : "MyCumulus GNSS"
},
"uri" : "/v1/location/64e0a6cf70a5f601e6d3ac70",
"status" : 200
}
Login using name and password. The name may be either the user name or the e-mail address. Once logged in, the user needs the authentication code X-Auth-Token to access the public MyCumulus API functions.
The request body should contain a JSON object named credentials containing the user name and password, and an optional boolean field named remember.
If remember is set to true, the user session will be kept active until the user has explicitely logged out.
By default remember is set to false and the user session will be closed after 24 hours.
See also:
Users - Logout
Users - Retrieve (Admin)
Users - Retrieve (Collaborator)
POST /v1/users/login
Content-Type: application/json
{
"credentials" : {
"name" : "DrPyth",
"password" : "MyPassword"
},
"remember" : false
}
{
"uri" : "/v1/users/login",
"status" : 202,
"token" : {
"expires_at" : "2023-08-20T11:26:08.271912Z",
"user_id" : "64e0a6d070a5f601e6d3ac79",
"key" : "a0ca7f52b85588fcd1348e7cff7ac019c6e3eaa5be4a56ee8d7e38bfe7245947cd3f360ad8cebc8489cb9707b8b752763c6a2375fa953f76827fa776347d153b6e802032b8e266f9983766b65877c7f434c05ca59857dd2f8eb92f234221309d4e1149273a71a811b3f1754adcc0eb6e23824c4146144d51cd6ae"
}
}
Logout of Admin or Collaborator.
See also:
Users - Login
POST /v1/users/logout
X-Auth-Token: a0ca7f52b85588fcd1348e7cff7ac019c6e3eaa5be4a56ee8d7e38bfe7245947cd3f360ad8cebc8489cb9707b8b752763c6a2375fa953f76827fa776347d153b6e802032b8e266f9983766b65877c7f434c05ca59857dd2f8eb92f234221309d4e1149273a71a811b3f1754adcc0eb6e23824c4146144d51cd6ae
{
"uri" : "/v1/users/logout",
"status" : 200
}
Retrieve information of the User. Example shows the response if user is an Admin User
GET /v1/users/64e0a6d070a5f601e6d3ac79
X-Auth-Token: 291227ae7ae165c76490e8e90d84c6a2d2acfd5dd4303e352b5db6d964ff0359a4b5acd8fb4b069ac29c8cc8e2c5b128b4f671410bdc215172cb7e3b81115824b2667a2ab61a1809e29b9ca76a67adc87ad6afde7c292624cf0d2321290b74ea45eaf1eec9ed06b8cc9b482822ea5948cc9464f76eb421b8cde853b9d6
{
"uri" : "/v1/users/64e0a6d070a5f601e6d3ac79",
"user" : {
"id" : "64e0a6d070a5f601e6d3ac79",
"email" : "drpyth@mycumulus.com",
"name" : "DrPyth",
"is_activated" : true,
"managed_users_ids" : [
"64e0a6d070a5f601e6d3ac81"
],
"created_at" : "2023-08-19T11:26:08.179Z",
"updated_at" : "2023-08-19T11:26:08.219Z",
"deleted_at" : null,
"user_type" : "admin_user",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : false,
"mc_marxact" : null
},
"status" : 200
}
Retrieve information of the User. Example shows the response if user is a collaborator
GET /v1/users/64e0a6d070a5f601e6d3ac81
X-Auth-Token: 291227ae7ae165c76490e8e90d84c6a2d2acfd5dd4303e352b5db6d964ff0359a4b5acd8fb4b069ac29c8cc8e2c5b128b4f671410bdc215172cb7e3b81115824b2667a2ab61a1809e29b9ca76a67adc87ad6afde7c292624cf0d2321290b74ea45eaf1eec9ed06b8cc9b482822ea5948cc9464f76eb421b8cde853b9d6
{
"uri" : "/v1/users/64e0a6d070a5f601e6d3ac81",
"user" : {
"id" : "64e0a6d070a5f601e6d3ac81",
"email" : "thales@mycumulus.com",
"name" : "Thales",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:08.367Z",
"updated_at" : null,
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
},
"status" : 200
}
Update the name and/or e-mail of the user.
PUT /v1/users/64e0a6d070a5f601e6d3ac79/update
Content-Type: application/json
X-Auth-Token: 291227ae7ae165c76490e8e90d84c6a2d2acfd5dd4303e352b5db6d964ff0359a4b5acd8fb4b069ac29c8cc8e2c5b128b4f671410bdc215172cb7e3b81115824b2667a2ab61a1809e29b9ca76a67adc87ad6afde7c292624cf0d2321290b74ea45eaf1eec9ed06b8cc9b482822ea5948cc9464f76eb421b8cde853b9d6
{
"name" : "DrPyth",
"email" : "mynewemail@mycumulus.com"
}
{
"uri" : "/v1/users/64e0a6d070a5f601e6d3ac79/update",
"user" : {
"id" : "64e0a6d070a5f601e6d3ac79",
"email" : "mynewemail@mycumulus.com",
"name" : "DrPyth",
"is_activated" : true,
"managed_users_ids" : [
],
"created_at" : "2023-08-19T11:26:08.179Z",
"updated_at" : "2023-08-19T11:26:08.597939Z",
"deleted_at" : null,
"user_type" : "admin_user",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : false,
"mc_marxact" : null
},
"status" : 200
}
An Admin user can invite collaborators with the invite call.
The response contains an invitation_code, that is required to signup a collaborator (also called a managed user).
The number of collaborators that can be added depends on the subscription.
See also:
Users - Signup of a Collaborator
Users - Delete Collaborator (by Admin User)
POST /v1/users/invite
Content-Type: application/json
X-Auth-Token: 291227ae7ae165c76490e8e90d84c6a2d2acfd5dd4303e352b5db6d964ff0359a4b5acd8fb4b069ac29c8cc8e2c5b128b4f671410bdc215172cb7e3b81115824b2667a2ab61a1809e29b9ca76a67adc87ad6afde7c292624cf0d2321290b74ea45eaf1eec9ed06b8cc9b482822ea5948cc9464f76eb421b8cde853b9d6
{
"email" : "Thales@mycumulus.com"
}
{
"invitation_code" : "3b951eee58789dc1b3e96cd517c237a08740fe6d94b62b84a04acb243ea64537e541f76a55932df8e3e732b50bee61059abb5f374525d92968c7b9152d39b70657115c53f749a4d5fd4e1b5435522bfc56bfa8765171fe8a3ac5b5a1cdb50e5835e68f1b824ceb1ae55dd075d2e51fe65c1d316855a2b20d0cf9f6cc",
"uri" : "/v1/users/invite",
"status" : 200
}
When an Admin user has sent an invitation, the collaborator will receive an e-mail. Using the link in the e-mail will activate the Signup page of the MyCumulus website.
When the user name and the password are given, the user can activate the account.
See also:
Users - Adding Collaborators
POST /v1/users/signupmanaged?token=3b951eee58789dc1b3e96cd517c237a08740fe6d94b62b84a04acb243ea64537e541f76a55932df8e3e732b50bee61059abb5f374525d92968c7b9152d39b70657115c53f749a4d5fd4e1b5435522bfc56bfa8765171fe8a3ac5b5a1cdb50e5835e68f1b824ceb1ae55dd075d2e51fe65c1d316855a2b20d0cf9f6cc
Content-Type: application/json
{
"email" : "Thales@mycumulus.com",
"name" : "Thales",
"password" : "MyPassword",
"user_type" : "collaborator"
}
{
"uri" : "/v1/users/signupmanaged",
"user" : {
"id" : "64e0a6d070a5f601e6d3ac84",
"email" : "thales@mycumulus.com",
"name" : "Thales",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:08.692967Z",
"updated_at" : null,
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
},
"status" : 201
}
A user can request to change his password with the Change Password function. The old and the new password must be given in the Request Body.
See also:
Users - Login
Users - Change Password of Collaborator
PUT /v1/users/changepassword
Content-Type: application/json
X-Auth-Token: 57ad8f65cb2e933fdcedc54220d86ac22f91fd97d601484154fa41949442e97f72685f1994391f50d9ebdea3ef1e45fc42fa4aa38bd1726012842f16b69e7627f17e8b43c34cf3274c3850ec846cd6bfe8f4f1b41c6f0c96557d48d1d2b27d8947bfaa63744d92e57541c8ba021ca4af0b946c8c69c59ea50ff8ac2b
{
"password" : "MyPassword",
"new_password" : "OldPassword"
}
{
"uri" : "/v1/users/changepassword",
"user" : {
"id" : "64e0a6d070a5f601e6d3ac84",
"email" : "thales@mycumulus.com",
"name" : "Thales",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:08.692Z",
"updated_at" : "2023-08-19T11:26:08.793903Z",
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
},
"status" : 200
}
Change of the password of a Collaborator by the Admin user.
See also:
Users - Login
Users - Change Password
POST /v1/users/resetcollaboratorpassword
X-Auth-Token: 291227ae7ae165c76490e8e90d84c6a2d2acfd5dd4303e352b5db6d964ff0359a4b5acd8fb4b069ac29c8cc8e2c5b128b4f671410bdc215172cb7e3b81115824b2667a2ab61a1809e29b9ca76a67adc87ad6afde7c292624cf0d2321290b74ea45eaf1eec9ed06b8cc9b482822ea5948cc9464f76eb421b8cde853b9d6
Content-Type: application/json
{
"collaborator_name" : "Thales",
"new_password" : "NewPassword"
}
{
"uri" : "/v1/users/resetcollaboratorpassword",
"user" : {
"id" : "64e0a6d070a5f601e6d3ac84",
"email" : "thales@mycumulus.com",
"name" : "Thales",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:08.692Z",
"updated_at" : "2023-08-19T11:26:08.883732Z",
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
},
"status" : 200
}
Returns the number of all Collaborators that the Admin user has added. The count includes the Admin user.
See also:
Users - Adding Collaborators
Users - Delete Collaborator (by Admin User)
Users - Get Collaborators
GET /v1/users/64e0a6d070a5f601e6d3ac79/count
X-Auth-Token: d76b5281ae6891c5eb0cd84818f032959cbd336eb76bc543ef91432052baef78c1587b94bab55ca5f1b32b3f31d67109556d2df1a3d3465ac1c120858473e7a9c0ac816c171c455db7edf63305ed18aba306cfafd5390d67fe64610fee375a2e67e57d6be765103d966c0411bf053e84cbaf6ecfaec8c8daecdb2b
{
"number_of_users" : 2
}
Returns a list of all Collaborators that the Admin user has added.
See also:
Users - Adding Collaborators
Users - Delete Collaborator (by Admin User)
GET /v1/users/64e0a6d070a5f601e6d3ac79/managed?page=1&perPage=100
X-Auth-Token: d76b5281ae6891c5eb0cd84818f032959cbd336eb76bc543ef91432052baef78c1587b94bab55ca5f1b32b3f31d67109556d2df1a3d3465ac1c120858473e7a9c0ac816c171c455db7edf63305ed18aba306cfafd5390d67fe64610fee375a2e67e57d6be765103d966c0411bf053e84cbaf6ecfaec8c8daecdb2b
{
"uri" : "/v1/users/64e0a6d070a5f601e6d3ac79/managed",
"users" : {
"metadata" : {
"uris" : {
"last" : "/v1/users/64e0a6d070a5f601e6d3ac79/managed?page=1&perPage=100",
"self" : "/v1/users/64e0a6d070a5f601e6d3ac79/managed",
"first" : "/v1/users/64e0a6d070a5f601e6d3ac79/managed?page=1&perPage=100"
},
"pages" : 1,
"total_count" : 1,
"page" : 1,
"page_count" : 1,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/users/64e0a6d070a5f601e6d3ac79/managed?page=1&perPage=100",
"self" : "https://api.mycumulus.com/v1/users/64e0a6d070a5f601e6d3ac79/managed",
"first" : "https://api.mycumulus.com/v1/users/64e0a6d070a5f601e6d3ac79/managed?page=1&perPage=100"
}
},
"instances" : [
{
"id" : "64e0a6d070a5f601e6d3ac84",
"email" : "thales@mycumulus.com",
"name" : "Thales",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:08.692Z",
"updated_at" : "2023-08-19T11:26:08.934Z",
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
}
]
},
"status" : 200
}
This command will give permission to the Collaborator to create projects. Only an Admin can grant this permission.
The request body contains a JSON object named permissions.
Only the structure shown in the example below is valid.
The Admin user acts as a super user and has all permissions to projects, templates, features and files owned by a collaborator.
See also:
Projects - Create a project
Users - Revoke Collaborator permission to create projects
PUT /v1/users/64e0a6d170a5f601e6d3ac88/grant
Content-Type: application/json
X-Auth-Token: d76b5281ae6891c5eb0cd84818f032959cbd336eb76bc543ef91432052baef78c1587b94bab55ca5f1b32b3f31d67109556d2df1a3d3465ac1c120858473e7a9c0ac816c171c455db7edf63305ed18aba306cfafd5390d67fe64610fee375a2e67e57d6be765103d966c0411bf053e84cbaf6ecfaec8c8daecdb2b
{
"permissions" : {
"projects" : [
"create"
]
}
}
{
"uri" : "/v1/users/64e0a6d170a5f601e6d3ac88/grant",
"user" : {
"id" : "64e0a6d170a5f601e6d3ac88",
"email" : "porphyry@mycumulus.com",
"name" : "Porphyry",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:09.146Z",
"updated_at" : "2023-08-19T11:26:09.190924Z",
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
"create"
]
}
},
"status" : 200
}
This command will revoke the permission of a Collaborator to create projects. Only an Admin can revoke this permission.
The request body contains a JSON object named permissions.
Only the structure shown in the example below is valid.
The Admin user acts as a super user and has all permissions to projects, templates, features and files owned by a collaborator.
See also:
Projects - Create a project
Users - Grant Collaborator permission to create projects
PUT /v1/users/64e0a6d170a5f601e6d3ac88/revoke
Content-Type: application/json
X-Auth-Token: d76b5281ae6891c5eb0cd84818f032959cbd336eb76bc543ef91432052baef78c1587b94bab55ca5f1b32b3f31d67109556d2df1a3d3465ac1c120858473e7a9c0ac816c171c455db7edf63305ed18aba306cfafd5390d67fe64610fee375a2e67e57d6be765103d966c0411bf053e84cbaf6ecfaec8c8daecdb2b
{
"permissions" : {
"projects" : [
"create"
]
}
}
{
"uri" : "/v1/users/64e0a6d170a5f601e6d3ac88/revoke",
"user" : {
"id" : "64e0a6d170a5f601e6d3ac88",
"email" : "porphyry@mycumulus.com",
"name" : "Porphyry",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:09.146Z",
"updated_at" : "2023-08-19T11:26:09.221279Z",
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
},
"status" : 200
}
Delete a Collaborator. When deleted, all projects owned by the Collaborator, and consequently the subordinate templates and features, will be removed.
See also:
Users - Adding Collaborators
Users - Number of Collaborators
Users - Get Collaborators
DELETE /v1/managedusers/64e0a6d170a5f601e6d3ac88
X-Auth-Token: d76b5281ae6891c5eb0cd84818f032959cbd336eb76bc543ef91432052baef78c1587b94bab55ca5f1b32b3f31d67109556d2df1a3d3465ac1c120858473e7a9c0ac816c171c455db7edf63305ed18aba306cfafd5390d67fe64610fee375a2e67e57d6be765103d966c0411bf053e84cbaf6ecfaec8c8daecdb2b
{
"uri" : "/v1/managedusers/64e0a6d170a5f601e6d3ac88",
"user" : {
"id" : "64e0a6d170a5f601e6d3ac88",
"email" : "porphyry@mycumulus.com",
"name" : "Porphyry",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:09.146Z",
"updated_at" : "2023-08-19T11:26:09.221Z",
"deleted_at" : "2023-08-19T11:26:09.257379Z",
"user_type" : "collaborator",
"customer_id" : "64e0a6d070a5f601e6d3ac7b",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d070a5f601e6d3ac79",
"permissions" : {
"projects" : [
]
}
},
"status" : 200
}
Creates a project. An Admin user can always create projects. A Collaborator requires permission, see Users - Grant Collaborator permission to create projects to create projects.
A user that created the project, will become the owner of the project.
The owner of a project has all permissions. None can be revoked.
A project can be a 'template', a 'domain' or a plain 'project'. A project of type 'template' is intended to be used as a template to create plain projects. A 'domain' groups forms that belong to the same domain. E.g. archeology, biology, drilling, etc.A project created by a user is a private project. It means that the project can only be shared by users being part of the same organisation (same customer).The MyCumulus system contains public project templates and public domains. This allows client applications to duplicate public project templates and forms.
See also:
Users - Grant Collaborator permission to create projects
Projects - Update the project data
Projects - Delete a Project
Projects - Duplicate a Project
Projects - Copy Project Template
Project/Members - Retrieve information of a member of a project.
Projects - Retrieve projects (Admin User)
Projects - Retrieve projects (Collaborator)
POST /v1/projects
Content-Type: application/json
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"name" : "Test Project",
"description" : "Description of Test Project",
"project_class" : "project",
"archived" : false
}
{
"project" : {
"id" : "64e0a6d170a5f601e6d3ac91",
"name" : "Test Project",
"description" : "Description of Test Project",
"image_file_url" : null,
"template_ids" : [
],
"created_at" : "2023-08-19T11:26:09.630828Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : null,
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "project",
"visibility" : "private",
"archived" : false
},
"uri" : "/v1/projects",
"status" : 201
}
Updates the information of the specified project. This API can be used to change the project class, and to archive/unarchive a project.The API does not allow to change a project template or a domain to a plain project. Other changes of project class are allowed.
See also:
Projects - Create a project
PUT /v1/projects/64e0a6d170a5f601e6d3ac91
Content-Type: application/json
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"name" : "Test Project changed",
"description" : "Description of Test Project changed",
"project_class" : "template",
"archived" : false
}
{
"project" : {
"id" : "64e0a6d170a5f601e6d3ac91",
"name" : "Test Project changed",
"description" : "Description of Test Project changed",
"image_file_url" : null,
"template_ids" : [
],
"created_at" : "2023-08-19T11:26:09.630Z",
"updated_at" : "2023-08-19T11:26:09.710042Z",
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : "64e0a6d170a5f601e6d3ac8a",
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "template",
"visibility" : "private",
"archived" : false
},
"uri" : "/v1/projects/64e0a6d170a5f601e6d3ac91",
"status" : 200
}
The X-Auth-Token may refer to an Admin user or to a Collaborator. If:
- Admin user: returns the number of projects that are created by the user plus the projects created by its collaborators.
As a consequence, the number of projects may be larger than the number of projects returned by the call: Projects - Retrieve projects (Admin User)
- Collaborator: returns the number of projects that are (1) created by the collaborator, plus (2) the projects the collaborator is member of.
The user that created the project is also called the owner of the project.
See also:
Projects - Create a project
GET /v1/projects/count/
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"number_of_projects" : 3
}
The X-Auth-Token may refer to an Admin user or to a Collaborator. If project_class = "project":
- Admin user: returns all projects that are created by the user. The projects created by its collaborators cannot be obtained.
- Collaborator: returns all projects that are (1) created by the collaborator, and (2) the projects the collaborator is member of.
The example below shows the result when the function is called by an Admin (the X-Auth-Token is of an Admin).
The query contains (optionally):
- proClass: "project", "domain" or "template". Default = "project"
- visibility: "private", or "public". Default = "private"
- archived: "true", or "false". Default = "false"
The list will return only the projects satisfying the query.
See also:
Projects - Create a project
Projects - Retrieve projects (Collaborator)
GET /v1/projects?proClass=domain&visibility=public&archived=false&perPage=2000
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"projects" : {
"metadata" : {
"uris" : {
"last" : "/v1/projects?page=1&perPage=2000",
"self" : "/v1/projects",
"first" : "/v1/projects?page=1&perPage=2000"
},
"pages" : 1,
"total_count" : 2,
"page" : 1,
"page_count" : 2,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/projects?page=1&perPage=2000",
"self" : "https://api.mycumulus.com/v1/projects",
"first" : "https://api.mycumulus.com/v1/projects?page=1&perPage=2000"
}
},
"instances" : [
{
"id" : "61c767f8ed111050367c8aa6",
"name" : "Boringen",
"description" : "Formulieren voor opmeten van boringen",
"image_file_url" : null,
"template_ids" : [
"61c768b3ed111050367c8aad",
"61c77194ed111050367c8ade"
],
"created_at" : "2021-12-25T18:50:32.803Z",
"updated_at" : "2021-12-25T19:31:32.023Z",
"deleted_at" : null,
"created_by" : "60c398c7ed1110705153afb6",
"updated_by" : "60c398c7ed1110705153afb6",
"deleted_by" : null,
"customer_id" : "60c398c7ed1110705153afb6",
"project_class" : "domain",
"visibility" : "public",
"archived" : false
},
{
"id" : "61a1f8b0ed111050367b9726",
"name" : "Diagnosis and testing",
"description" : "Forms useful for diagnosis and testing",
"image_file_url" : null,
"template_ids" : [
"61a1f90aed111050367b9729",
"62113f6ced11100895364dee"
],
"created_at" : "2021-11-27T09:21:52.225Z",
"updated_at" : "2022-02-19T19:05:16.115Z",
"deleted_at" : null,
"created_by" : "60c398c7ed1110705153afb6",
"updated_by" : "60c398c7ed1110705153afb6",
"deleted_by" : null,
"customer_id" : "60c398c7ed1110705153afb6",
"project_class" : "domain",
"visibility" : "public",
"archived" : false
}
]
},
"uri" : "/v1/projects",
"status" : 200
}
The X-Auth-Token may refer to an Admin user or to a Collaborator. If:
- Admin user: returns all projects that are created by the user. The projects created by its collaborators cannot be obtained.
- Collaborator: returns all projects that are (1) created by the collaborator, and (2) the projects the collaborator is member of.
The example below shows the result when the function is called by a collaborator (the X-Auth-Token is of a collaborator). Notice that the name of the object in the JSON structure containing the projects = project_members.
The command returns the same projects as the (obsolete) call Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
See also:
Projects - Create a project
Projects - Retrieve projects (Admin User)
GET /v1/projects?proClass=project&visibility=private&archived=false&perPage=2000
X-Auth-Token: e889ca794615f833188d1cc08a8028fbd8d107d6df0662a1e533f9af444e56bc5fc3c64775abcc2d4240d48bf1f3bf2ca35967f96cfd01b3b4fdaf7bc56bb57cabe3718e32c1d2f3ee348e391b938ca0c01f1abde7c7d2a6b735aec727a9b9e8fe070edaa3cdab7b5fbb33031698af4cd725f23354a5036d5777f4860
{
"projects" : {
"metadata" : {
"uris" : {
"last" : "/v1/projects?page=1&perPage=2000",
"self" : "/v1/projects",
"first" : "/v1/projects?page=1&perPage=2000"
},
"pages" : 1,
"total_count" : 2,
"page" : 1,
"page_count" : 2,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/projects?page=1&perPage=2000",
"self" : "https://api.mycumulus.com/v1/projects",
"first" : "https://api.mycumulus.com/v1/projects?page=1&perPage=2000"
}
},
"instances" : [
{
"id" : "64e0a6d270a5f601e6d3ac98",
"name" : "Project of Thales",
"description" : "Description of project",
"image_file_url" : null,
"template_ids" : [
],
"created_at" : "2023-08-19T11:26:10.079Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac95",
"updated_by" : null,
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "project",
"visibility" : "private",
"archived" : false
},
{
"id" : "64e0a6d170a5f601e6d3ac92",
"name" : "Test Project 2",
"description" : "Description of Test Project 2",
"image_file_url" : null,
"template_ids" : [
],
"created_at" : "2023-08-19T11:26:09.783Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : null,
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "project",
"visibility" : "private",
"archived" : false
}
]
},
"uri" : "/v1/projects",
"status" : 200
}
Reads the information of the specified project.
See also:
Projects - Create a project
GET /v1/projects/64e0a6d170a5f601e6d3ac91
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"project" : {
"id" : "64e0a6d170a5f601e6d3ac91",
"name" : "Test Project changed",
"description" : "Description of Test Project changed",
"image_file_url" : null,
"template_ids" : [
],
"created_at" : "2023-08-19T11:26:09.630Z",
"updated_at" : "2023-08-19T11:26:09.710Z",
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : "64e0a6d170a5f601e6d3ac8a",
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "template",
"visibility" : "private",
"archived" : false
},
"uri" : "/v1/projects/64e0a6d170a5f601e6d3ac91",
"status" : 200
}
Delete the specified project.
When deleted, all templates in the project, and consequently the subordinate features, will be removed.
See also:
Projects - Create a project
DELETE /v1/projects/64e0a6d170a5f601e6d3ac92
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"project" : {
"id" : "64e0a6d170a5f601e6d3ac92",
"name" : "Test Project 2",
"description" : "Description of Test Project 2",
"image_file_url" : null,
"template_ids" : [
],
"created_at" : "2023-08-19T11:26:09.783Z",
"updated_at" : null,
"deleted_at" : "2023-08-19T11:26:10.291526Z",
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : null,
"deleted_by" : "64e0a6d170a5f601e6d3ac8a",
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "project",
"visibility" : "private",
"archived" : false
},
"uri" : "/v1/projects/64e0a6d170a5f601e6d3ac92",
"status" : 200
}
Duplicates the project. De duplicated project will contain the same templates as the original project.
The user calling the duplicate API will become the owner of the project. When duplicating the project of another user, the rights of the original project are not duplicated.
See also:
Projects - Create a project
POST /v1/project/duplicate
Content-Type: application/json
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"project_id" : "64e0a6d270a5f601e6d3ac9a",
"name" : "Test Project Copy",
"description" : "Description of Test Project"
}
{
"project" : {
"id" : "64e0a6d270a5f601e6d3ac9c",
"name" : "Test Project Copy",
"description" : "Description of Test Project",
"image_file_url" : null,
"template_ids" : [
"64e0a6d270a5f601e6d3ac9d"
],
"created_at" : "2023-08-19T11:26:10.442057Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : null,
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "project",
"visibility" : "private",
"archived" : false
},
"uri" : "/v1/project/duplicate",
"status" : 201
}
Duplicates a private or public project template and converts it to a plain project. De new project will contain the same templates as the original project template.
The user calling this API will become the owner of the project. When duplicating the project template of another user, the rights of the original project are not duplicated.
See also:
Projects - Create a project
POST /v1/project/template/copy
Content-Type: application/json
X-Auth-Token: 352f46b64857e6553a2f78f2924c92e6ac4bfc1189d5f2c49541724927f26de39f927eb401fe32aa32973709fc09e361774d52f338dec29352134f08783b1c7b33f90c4f9511b42b23182d52cd5bef4bc4f1c70ce266e66ef4262dee377151adadf5dd7e59d1f6d7691b98a24bbf428f6afdb32cdfa5ea95582c362eac
{
"user_id" : "64e0a6d170a5f601e6d3ac8a",
"project_id" : "64e0a6d270a5f601e6d3ac9a",
"name" : "Sewage Vosselaar",
"description" : "Sewage Survey in Vosselaar"
}
{
"project" : {
"id" : "64e0a6d270a5f601e6d3ac9e",
"name" : "Sewage Vosselaar",
"description" : "Sewage Survey in Vosselaar",
"image_file_url" : null,
"template_ids" : [
"64e0a6d270a5f601e6d3ac9f"
],
"created_at" : "2023-08-19T11:26:10.502828Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d170a5f601e6d3ac8a",
"updated_by" : null,
"deleted_by" : null,
"customer_id" : "64e0a6d170a5f601e6d3ac8c",
"project_class" : "project",
"visibility" : "private",
"archived" : false
},
"uri" : "/v1/project/template/copy",
"status" : 201
}
Add a collaborator to a project. When a collaborator is added, he becomes a member of the project.
Only the owner of the project or the Admin is authorised to add members to his project(s).
A member has initially no rights (permissions) to the templates of the owner of the project. The permissions (rights) are granted using: Project/Members - Grant permissions to collaborator
Request : POST /v1/projects/:project_id/members
See also:
Project/Members - Remove a user from a project.
Project/Members - Grant permissions to collaborator
Project/Members - Revoke permissions from collaborator
Project/Members - Retrieve the list of 'all members (users)' of the project.
Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
Project/Members - Retrieve the list of 'all projects (permissions)' user is member of.
POST /v1/projects/64e0a6d270a5f601e6d3aca8/members
Content-Type: application/json
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
X-Working-Project-Id: 64e0a6d270a5f601e6d3aca8
{
"user_id" : "64e0a6d270a5f601e6d3acab"
}
{
"project_member" : {
"id" : "64e0a6d370a5f601e6d3acae",
"user_id" : "64e0a6d270a5f601e6d3acab",
"project_id" : "64e0a6d270a5f601e6d3aca8",
"permissions" : {
"features" : [
]
},
"created_at" : "2023-08-19T11:26:11.099499Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : null,
"deleted_by" : null
},
"uri" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members",
"status" : 201
}
Returns information of the member of the project. Here you can find the permissions related to templates/features.
See also:
Projects - Create a project
GET /v1/projects/64e0a6d270a5f601e6d3aca8/members/64e0a6d270a5f601e6d3acab
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
{
"project_member" : {
"id" : "64e0a6d370a5f601e6d3acae",
"user_id" : "64e0a6d270a5f601e6d3acab",
"project_id" : "64e0a6d270a5f601e6d3aca8",
"permissions" : {
"features" : [
{
"template_id" : "64e0a6d370a5f601e6d3acb0",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
},
{
"template_id" : "64e0a6d370a5f601e6d3acb1",
"permission_types" : [
"read",
"update"
]
}
]
},
"created_at" : "2023-08-19T11:26:11.099Z",
"updated_at" : "2023-08-19T11:26:11.303Z",
"deleted_at" : null,
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : "64e0a6d270a5f601e6d3aca1",
"deleted_by" : null
},
"uri" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members/64e0a6d270a5f601e6d3acab",
"status" : 200
}
Returns all members of the project. The Admin user will never be in the list. When the owner is a collaborator, he will be in the list.
The information in the list is general information about each collaborator. If you need for a specific member the permissions to templates and features see: Project/Members - Retrieve information of a member of a project.
See also:
Projects - Create a project
Project/Members - Add a user to a project.
Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
Project/Members - Retrieve the list of 'all projects (permissions)' user is member of.
GET /v1/projects/64e0a6d270a5f601e6d3aca8/members?page=1&perPage=100
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
{
"uri" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members",
"users" : {
"metadata" : {
"uris" : {
"last" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members?page=1&perPage=100",
"self" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members",
"first" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members?page=1&perPage=100"
},
"pages" : 1,
"total_count" : 2,
"page" : 1,
"page_count" : 2,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/projects/64e0a6d270a5f601e6d3aca8/members?page=1&perPage=100",
"self" : "https://api.mycumulus.com/v1/projects/64e0a6d270a5f601e6d3aca8/members",
"first" : "https://api.mycumulus.com/v1/projects/64e0a6d270a5f601e6d3aca8/members?page=1&perPage=100"
}
},
"instances" : [
{
"id" : "64e0a6d370a5f601e6d3acad",
"email" : "porphyry@mycumulus.com",
"name" : "Porphyry",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:11.053Z",
"updated_at" : null,
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d270a5f601e6d3aca3",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d270a5f601e6d3aca1",
"permissions" : {
"projects" : [
]
}
},
{
"id" : "64e0a6d270a5f601e6d3acab",
"email" : "thales@mycumulus.com",
"name" : "Thales",
"is_activated" : true,
"created_at" : "2023-08-19T11:26:10.976Z",
"updated_at" : null,
"deleted_at" : null,
"user_type" : "collaborator",
"customer_id" : "64e0a6d270a5f601e6d3aca3",
"temporary_user" : null,
"mc_marxact" : null,
"manager_id" : "64e0a6d270a5f601e6d3aca1",
"permissions" : {
"projects" : [
]
}
}
]
},
"status" : 200
}
Retrieve the list of 'all projects' the collaborator is member of, and the projects owned by the collaborator. This call should not be used for Admin users since they can't be member of projects of a collaborator. For an Admin user, this call does not even return it's own projects.
For a collaborator, the command returns the same projects as the call Projects - Retrieve projects (Collaborator)
See also:
Projects - Create a project
Project/Members - Add a user to a project.
Project/Members - Retrieve the list of 'all members (users)' of the project.
Project/Members - Retrieve the list of 'all projects (permissions)' user is member of.
GET /v1/users/64e0a6d270a5f601e6d3acab/projects?page=1&perPage=100
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
{
"projects" : {
"metadata" : {
"uris" : {
"last" : "/v1/users/64e0a6d270a5f601e6d3acab/projects?page=1&perPage=1",
"self" : "/v1/users/64e0a6d270a5f601e6d3acab/projects",
"first" : "/v1/users/64e0a6d270a5f601e6d3acab/projects?page=1&perPage=1"
},
"pages" : 1,
"total_count" : 1,
"page" : 1,
"page_count" : 1,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/users/64e0a6d270a5f601e6d3acab/projects?page=1&perPage=1",
"self" : "https://api.mycumulus.com/v1/users/64e0a6d270a5f601e6d3acab/projects",
"first" : "https://api.mycumulus.com/v1/users/64e0a6d270a5f601e6d3acab/projects?page=1&perPage=1"
}
},
"instances" : [
{
"id" : "64e0a6d270a5f601e6d3aca8",
"name" : "Test Project",
"description" : "Description of Test Project",
"image_file_url" : null,
"template_ids" : [
"64e0a6d370a5f601e6d3acb0",
"64e0a6d370a5f601e6d3acb1"
],
"created_at" : "2023-08-19T11:26:10.846Z",
"updated_at" : "2023-08-19T11:26:11.257Z",
"deleted_at" : null,
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : "64e0a6d270a5f601e6d3aca1",
"deleted_by" : null,
"customer_id" : "64e0a6d270a5f601e6d3aca3",
"project_class" : "project",
"visibility" : "private",
"archived" : false
}
]
},
"uri" : "/v1/users/64e0a6d270a5f601e6d3acab/projects",
"status" : 200
}
This command is similar to Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete), but retrieves for 'all projects' the user is member of, the permissions to the features of the templates.
Using this call for Admin users does not make sense. An empty list will be returned.
For a collaborator, the command returns the same projects as the call Projects - Retrieve projects (Collaborator) but will not contain names of the projects. Each project in the list will have a field "permissions" that specifies the operations (create, read, update, delete) are allowed on the features of each template in the project.
For more information about permissions, see Project/Members - Grant permissions to collaborator
See also:
Projects - Create a project
Project/Members - Add a user to a project.
Project/Members - Retrieve the list of 'all members (users)' of the project.
Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
GET /v1/users/64e0a6d270a5f601e6d3acab/projectmembers
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
{
"project_members" : {
"metadata" : {
"uris" : {
"last" : "/v1/users/64e0a6d270a5f601e6d3acab/projectmembers?page=1&perPage=50",
"self" : "/v1/users/64e0a6d270a5f601e6d3acab/projectmembers",
"first" : "/v1/users/64e0a6d270a5f601e6d3acab/projectmembers?page=1&perPage=50"
},
"pages" : 1,
"total_count" : 1,
"page" : 1,
"page_count" : 1,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/users/64e0a6d270a5f601e6d3acab/projectmembers?page=1&perPage=50",
"self" : "https://api.mycumulus.com/v1/users/64e0a6d270a5f601e6d3acab/projectmembers",
"first" : "https://api.mycumulus.com/v1/users/64e0a6d270a5f601e6d3acab/projectmembers?page=1&perPage=50"
}
},
"instances" : [
{
"id" : "64e0a6d370a5f601e6d3acae",
"user_id" : "64e0a6d270a5f601e6d3acab",
"project_id" : "64e0a6d270a5f601e6d3aca8",
"permissions" : {
"features" : [
{
"template_id" : "64e0a6d370a5f601e6d3acb0",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
},
{
"template_id" : "64e0a6d370a5f601e6d3acb1",
"permission_types" : [
"read",
"update"
]
}
]
},
"created_at" : "2023-08-19T11:26:11.099Z",
"updated_at" : "2023-08-19T11:26:11.303Z",
"deleted_at" : null,
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : "64e0a6d270a5f601e6d3aca1",
"deleted_by" : null
}
]
},
"uri" : "/v1/users/64e0a6d270a5f601e6d3acab/projectmembers",
"status" : 200
}
Remove a collaborator from a project. The collaborator will not be anymore a member of the project. All his permissions to the project are removed.
This call does not remove the collaborator, nor will it remove any data.
See also:
Project/Members - Add a user to a project.
Project/Members - Retrieve the list of 'all members (users)' of the project.
Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
Project/Members - Retrieve the list of 'all projects (permissions)' user is member of.
DELETE /v1/projects/64e0a6d270a5f601e6d3aca8/members/64e0a6d370a5f601e6d3acad
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
X-Working-Project-Id: 64e0a6d270a5f601e6d3aca8
{
"project_member" : {
"id" : "64e0a6d370a5f601e6d3acaf",
"user_id" : "64e0a6d370a5f601e6d3acad",
"project_id" : "64e0a6d270a5f601e6d3aca8",
"permissions" : {
"features" : [
]
},
"created_at" : "2023-08-19T11:26:11.128Z",
"updated_at" : null,
"deleted_at" : "2023-08-19T11:26:11.502405Z",
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : null,
"deleted_by" : "64e0a6d270a5f601e6d3aca1"
},
"uri" : "/v1/projects/64e0a6d270a5f601e6d3aca8/members/64e0a6d370a5f601e6d3acad",
"status" : 200
}
This command will give permissions to a member of the given project. Only the owner of the project or the Admin is authorised to grant permissions to members.
The request body contains a JSON object named permissions.
Only the structure shown in the example below is valid. The JSON array permissions is an array containing the permissions to be granted for each template.
Valid value in array permission_types:
- read: the user may read features in the template. If not in the list the user has no access at all to the template.
- create: the user may create features in the template.
- update: the user may update existing features in the template.
- delete: the user may delete features in the template.
When granting a permission, the same permission may not yet be present yet. So either add permissions for a new template, or add a permission for a template already in the list.
The Admin user acts as a super user and has by default all permissions.
See also:
Project/Members - Revoke permissions from collaborator
Project/Members - Retrieve information of a member of a project.
Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
Project/Members - Retrieve the list of 'all projects (permissions)' user is member of.
Project/Members - Retrieve the list of 'all members (users)' of the project.
PUT /v1/projects/64e0a6d270a5f601e6d3aca8/grant
Content-Type: application/json
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
X-Working-Project-Id: 64e0a6d270a5f601e6d3aca8
{
"user_id" : "64e0a6d270a5f601e6d3acab",
"permissions" : {
"features" : [
{
"template_id" : "64e0a6d370a5f601e6d3acb1",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
}
]
}
}
{
"project_member" : {
"id" : "64e0a6d370a5f601e6d3acae",
"user_id" : "64e0a6d270a5f601e6d3acab",
"project_id" : "64e0a6d270a5f601e6d3aca8",
"permissions" : {
"features" : [
{
"template_id" : "64e0a6d370a5f601e6d3acb0",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
},
{
"template_id" : "64e0a6d370a5f601e6d3acb1",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
}
]
},
"created_at" : "2023-08-19T11:26:11.099Z",
"updated_at" : "2023-08-19T11:26:11.535123Z",
"deleted_at" : null,
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : "64e0a6d270a5f601e6d3aca1",
"deleted_by" : null
},
"uri" : "/v1/projects/64e0a6d270a5f601e6d3aca8/grant",
"status" : 200
}
This command will revoke permissions from a member of the given project. Only the owner of the project or the Admin is authorised to revoke permissions.The request body and meaning of the names and values is described in: Project/Members - Grant permissions to collaborator
Only permissions that are already in the list may be revoked.
See also:
Project/Members - Grant permissions to collaborator
Project/Members - Retrieve information of a member of a project.
Project/Members - Retrieve the list of 'all projects' user is member of. (Obsolete)
Project/Members - Retrieve the list of 'all projects (permissions)' user is member of.
Project/Members - Retrieve the list of 'all members (users)' of the project.
PUT /v1/projects/64e0a6d270a5f601e6d3aca8/revoke
Content-Type: application/json
X-Auth-Token: a4c1682894bbe9e85293b73d5d6728e035d0668e82628bd5b12e7801033e025b067475482b792b331676467d252ad29129f5f8987bd8d73dfa60c995852fd1c18f47f0fd5878b4fa29c24a60aa117954672194b93d1cf24113ac173627937feccb966df9b84bc635aaf962c953bdc98ed8ea2b954b8950da87e4ea9c8ca9
X-Working-Project-Id: 64e0a6d270a5f601e6d3aca8
{
"user_id" : "64e0a6d270a5f601e6d3acab",
"permissions" : {
"features" : [
{
"template_id" : "64e0a6d370a5f601e6d3acb1",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
}
]
}
}
{
"project_member" : {
"id" : "64e0a6d370a5f601e6d3acae",
"user_id" : "64e0a6d270a5f601e6d3acab",
"project_id" : "64e0a6d270a5f601e6d3aca8",
"permissions" : {
"features" : [
{
"template_id" : "64e0a6d370a5f601e6d3acb0",
"permission_types" : [
"create",
"read",
"update",
"delete"
]
}
]
},
"created_at" : "2023-08-19T11:26:11.099Z",
"updated_at" : "2023-08-19T11:26:11.567018Z",
"deleted_at" : null,
"created_by" : "64e0a6d270a5f601e6d3aca1",
"updated_by" : "64e0a6d270a5f601e6d3aca1",
"deleted_by" : null
},
"uri" : "/v1/projects/64e0a6d270a5f601e6d3aca8/revoke",
"status" : 200
}
Creates a new template. A template will normally be used with the MyCumulus app to view, update and collect data that will be represented as features in the MyCumulus database.
The list of attributes specifies the attributes of the features generated from the template.
The list of fields specifies the fields in the form.
The list of attributes and the list of fields must match.
See also:
Templates - Update the form
Templates - Delete a form
Templates - Retrieve a form
Templates - Duplicate a form
Templates - Copy a form from domain project
Templates - Retrieve the list of all forms of a projectStyles - Retrieve styles
POST /v1/templates
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
Content-Type: application/json
X-Working-Project-Id: 64e0a6d370a5f601e6d3acba
{
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Survey with photo",
"description" : "First Template",
"image_file_url" : null,
"default_style_id" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "integer",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file"
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date"
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time"
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : false
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string"
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string"
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"initial_value" : 1000,
"step" : 1,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "integerfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"photo_size" : "Large",
"photo_quality" : "Maximum",
"use_previous_value" : false,
"constraints" : [
]
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"default_value_expression" : "=Today()"
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"event_actions" : [
"OnLocationChange->Now()"
]
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
]
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"event_actions" : [
"OnLocationChange->Address().Community"
]
}
]
}
}
{
"template" : {
"id" : "64e0a6d370a5f601e6d3acbb",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Survey with photo",
"description" : "First Template",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"initial_value" : 1000,
"step" : 1
},
{
"_class" : "integerfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"photo_quality" : "maximum",
"photo_size" : "large"
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : "=Today()",
"constraints" : [
],
"default_value" : null
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Now()"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().Community"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:11.958936Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : null,
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"uri" : "/v1/templates",
"status" : 201
}
Update the template. The Request Body may contain only the properties to be updated. However it's advised to send the complete updated template again.
See also:
Templates - Create a form
Templates - Retrieve a form
PUT /v1/templates/64e0a6d370a5f601e6d3acbb
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
Content-Type: application/json
X-Working-Project-Id: 64e0a6d370a5f601e6d3acba
{
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file"
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date"
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time"
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : false
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string"
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string"
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"initial_value" : 1000,
"step" : 1,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "AN Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"photo_size" : "Large",
"photo_quality" : "Maximum",
"use_previous_value" : false,
"constraints" : [
]
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"default_value_expression" : "=Today()"
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"event_actions" : [
"OnLocationChange->Now()"
]
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
]
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"constraints" : [
],
"event_actions" : [
"OnLocationChange->Address().Community"
]
}
]
}
}
{
"template" : {
"id" : "64e0a6d370a5f601e6d3acbb",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Survey with photo",
"description" : "First Template",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"initial_value" : 1000,
"step" : 1
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "AN Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"photo_quality" : "maximum",
"photo_size" : "large"
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : "=Today()",
"constraints" : [
],
"default_value" : null
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Now()"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().Community"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:11.958Z",
"updated_at" : "2023-08-19T11:26:12.008812Z",
"deleted_at" : null,
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : "64e0a6d370a5f601e6d3acb3",
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"uri" : "/v1/templates/64e0a6d370a5f601e6d3acbb",
"status" : 200
}
Returns the number of templates in the project.
See also:
Templates - Create a form
Templates - Retrieve the list of all forms of a project
GET /v1/projects/64e0a6d370a5f601e6d3acba/templates/count
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
X-Working-Project-Id: 64e0a6d370a5f601e6d3acba
{
"number_of_templates" : 1
}
Retrieve the list of all the templates of a specific project. Also if the project is a domain or a project template.
The command: GET /v1/templates returns the same list if the project is a plain project.
When using the authentication of a collaborator, the command GET /v1/templates returns an error if the project is a domain or a project template.
See also:
Templates - Create a form
Templates - Number of forms in a project
GET /v1/projects/64e0a6d370a5f601e6d3acba/templates?page=1&perPage=100
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
X-Working-Project-Id: 64e0a6d370a5f601e6d3acba
{
"templates" : {
"metadata" : {
"uris" : {
"last" : "/v1/projects/64e0a6d370a5f601e6d3acba/templates?page=1&perPage=100",
"self" : "/v1/projects/64e0a6d370a5f601e6d3acba/templates",
"first" : "/v1/projects/64e0a6d370a5f601e6d3acba/templates?page=1&perPage=100"
},
"pages" : 1,
"total_count" : 1,
"page" : 1,
"page_count" : 1,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/projects/64e0a6d370a5f601e6d3acba/templates?page=1&perPage=100",
"self" : "https://api.mycumulus.com/v1/projects/64e0a6d370a5f601e6d3acba/templates",
"first" : "https://api.mycumulus.com/v1/projects/64e0a6d370a5f601e6d3acba/templates?page=1&perPage=100"
}
},
"instances" : [
{
"id" : "64e0a6d370a5f601e6d3acbb",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Survey with photo",
"description" : "First Template",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"initial_value" : 1000,
"step" : 1
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "AN Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"photo_quality" : "maximum",
"photo_size" : "large"
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : "=Today()",
"constraints" : [
],
"default_value" : null
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Now()"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().Community"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:11.958Z",
"updated_at" : "2023-08-19T11:26:12.008Z",
"deleted_at" : null,
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : "64e0a6d370a5f601e6d3acb3",
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
}
]
},
"uri" : "/v1/projects/64e0a6d370a5f601e6d3acba/templates",
"status" : 200
}
Retrieves a template.
See also:
Templates - Create a form
GET /v1/templates/64e0a6d370a5f601e6d3acbb
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
X-Working-Project-Id: 64e0a6d370a5f601e6d3acba
{
"template" : {
"id" : "64e0a6d370a5f601e6d3acbb",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Survey with photo",
"description" : "First Template",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"initial_value" : 1000,
"step" : 1
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "AN Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"photo_quality" : "maximum",
"photo_size" : "large"
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : "=Today()",
"constraints" : [
],
"default_value" : null
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Now()"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().Community"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:11.958Z",
"updated_at" : "2023-08-19T11:26:12.008Z",
"deleted_at" : null,
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : "64e0a6d370a5f601e6d3acb3",
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"uri" : "/v1/templates/64e0a6d370a5f601e6d3acbb",
"status" : 200
}
Deletes a form.
See also:
Templates - Create a form
DELETE /v1/templates/64e0a6d370a5f601e6d3acbb
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
X-Working-Project-Id: 64e0a6d370a5f601e6d3acba
{
"template" : {
"id" : "64e0a6d370a5f601e6d3acbb",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Survey with photo",
"description" : "First Template",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"initial_value" : 1000,
"step" : 1
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "AN Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"photo_quality" : "maximum",
"photo_size" : "large"
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : "=Today()",
"constraints" : [
],
"default_value" : null
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Now()"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().Community"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:11.958Z",
"updated_at" : "2023-08-19T11:26:12.008Z",
"deleted_at" : "2023-08-19T11:26:12.150866Z",
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : "64e0a6d370a5f601e6d3acb3",
"deleted_by" : "64e0a6d370a5f601e6d3acb3",
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"uri" : "/v1/templates/64e0a6d370a5f601e6d3acbb",
"status" : 200
}
Duplicates a form.
See also:
Templates - Create a form
Templates - Copy a form from domain project
POST /v1/template/duplicate
Content-Type: application/json
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
{
"project_id" : "64e0a6d370a5f601e6d3acba",
"template_id" : "64e0a6d470a5f601e6d3acbc",
"name" : "First Template Copy",
"description" : ""
}
{
"template" : {
"id" : "64e0a6d470a5f601e6d3acbd",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "First Template Copy",
"description" : "First Template",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Pointnumber",
"type" : "integer",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Distance",
"type" : "double",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Comment",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Photo",
"type" : "file",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Date",
"type" : "date",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Time",
"type" : "time",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Checked",
"type" : "boolean",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Address",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Community",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "autoincrementintegerfield",
"name" : "Pointnumber",
"label" : "Pointnumber",
"description" : "Automatically incremented",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"initial_value" : 1000,
"step" : 1
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Alphanumeric code",
"description" : "AN Code used by Pythagoras",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : true,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "decimalfield",
"name" : "Distance",
"label" : "Distance",
"description" : "Distance to the object",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Comment",
"label" : "Comment",
"description" : "",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "photofield",
"name" : "Photo",
"label" : "Photo",
"description" : "Please take a picture",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"photo_quality" : "maximum",
"photo_size" : "large"
},
{
"_class" : "datefield",
"name" : "Date",
"label" : "Date",
"description" : "Date of start survey",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : "=Today()",
"constraints" : [
],
"default_value" : null
},
{
"_class" : "timefield",
"name" : "Time",
"label" : "Time",
"description" : "Time of getting location",
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Now()"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "booleanfield",
"name" : "Checked",
"label" : "Checked",
"description" : "Has the survey been checked?",
"enabled" : true,
"visible" : true,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : false
},
{
"_class" : "stringfield",
"name" : "Address",
"label" : "Address",
"description" : "Street and house number",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().StreetAndNumber"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Community",
"label" : "Community",
"description" : "Place of survey",
"enabled" : false,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : [
"OnLocationChange->Address().Community"
],
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:12.241694Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : null,
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"uri" : "/v1/template/duplicate",
"status" : 201
}
Duplicates a private or public form stored in a domain project.
The user calling this API will become the owner of the form. Collaborators who are member of the project where the duplicated form is stored have no access to the new form.
See also:
Templates - Create a form
Templates - Duplicate a form
POST /v1/form/template/copy
Content-Type: application/json
X-Auth-Token: 8b14474e17dd7eb576c3936258d7e1198e1d9b91bd4822b78f26a44fcf848ec51fcadf3cac8d6cd5a4a787279273d74e6637e71de5ce73774dca20cf7ae063a16ea8644465effd310427f67f858afcbc99638bc79e17d97b66335e93422a61a1888f193a1f1e61468241b51dae66c59f190e412121d5a0b6c974f1c
{
"user_id" : "64e0a6d370a5f601e6d3acb3",
"project_id" : "64e0a6d370a5f601e6d3acba",
"template_id" : "64e0a6d470a5f601e6d3acc2"
}
{
"template" : {
"id" : "64e0a6d470a5f601e6d3acc3",
"project_id" : "64e0a6d370a5f601e6d3acba",
"name" : "Drilling",
"description" : "Simple",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "F1 Field 1",
"type" : "string",
"default_value" : "F1 Default Value Field 1",
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "F1 Field 2",
"type" : "string",
"default_value" : "F1 Default Value Field 2",
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "F1 Field 3",
"type" : "string",
"default_value" : "F1 Default Value Field 3",
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "stringfield",
"name" : "F1 Field 1",
"label" : "F1 Label Field 1",
"description" : "F1 Description Field 1",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : "F1 Default Value Field 1"
},
{
"_class" : "stringfield",
"name" : "F1 Field 2",
"label" : "F1 Label Field 2",
"description" : "F1 Description Field 2",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : "F1 Default Value Field 2"
},
{
"_class" : "stringfield",
"name" : "F1 Field 3",
"label" : "F1 Label Field 3",
"description" : "F1 Description Field 3",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : "F1 Default Value Field 3"
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:12.536016Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d370a5f601e6d3acb3",
"updated_by" : null,
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"uri" : "/v1/form/template/copy",
"status" : 201
}
Creates a style. A template can link to a style, allowing any MyCumulus client to make a graphical representation of the geometry, based on the information in the style.
The elements in the array indexes contains a "Name" field and a "Values field" (an array of value). For each combination Name-Value, there must be an entry in the attributes list. For example: when there are 2 elements in the name field, the first one containing 4 values and the second 3 values, the attributes list must contain exactly 12 style attributes.
The sequence in this array (4x3): (I(1).V1, I(2).V1), (I(1).V1, I(2).V2), (I(1).V1, I(2).V3, (I(1).V2, I(2).V1), (I(1).V2, I(2).V2), ... (I(1).V4, I(2).V3).
The attributes are used by MyCumulus clients to give the right representation (style) of each feature by taking the values of the fields whose names/values match with the names/values in the indexes array.
See also:
Styles - Update the style
Styles - Delete a style
Styles - Retrieve a style
POST /v1/styles
Content-Type: application/json
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
},
{
"name" : "Ownership",
"values" : [
"Private",
"Public",
null
]
}
],
"attributes" : [
{
"layer" : "House Private",
"color" : [
255,
0,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "House Public",
"color" : [
0,
255,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "House",
"color" : [
0,
0,
255
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "School Private",
"color" : [
255,
0,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "School Public",
"color" : [
0,
255,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "School",
"color" : [
0,
0,
255
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "Factory Private",
"color" : [
255,
0,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "Factory Public",
"color" : [
0,
255,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "Factory",
"color" : [
0,
0,
255
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "Building Private",
"color" : [
255,
0,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "Building Public",
"color" : [
0,
255,
0
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
},
{
"layer" : "Building",
"color" : [
0,
0,
255
],
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"point_style" : "square"
}
]
}
{
"style" : {
"id" : "64e0a6d570a5f601e6d3accf",
"created_at" : "2023-08-19T11:26:13.106811Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d470a5f601e6d3acc5",
"updated_by" : null,
"deleted_by" : null,
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
},
{
"name" : "Ownership",
"values" : [
"Private",
"Public",
null
]
}
],
"attributes" : [
{
"color" : [
255,
0,
0
],
"layer" : "House Private",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
255,
0
],
"layer" : "House Public",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
0,
255
],
"layer" : "House",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
255,
0,
0
],
"layer" : "School Private",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
255,
0
],
"layer" : "School Public",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
0,
255
],
"layer" : "School",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
255,
0,
0
],
"layer" : "Factory Private",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
255,
0
],
"layer" : "Factory Public",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
0,
255
],
"layer" : "Factory",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
255,
0,
0
],
"layer" : "Building Private",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
255,
0
],
"layer" : "Building Public",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
},
{
"color" : [
0,
0,
255
],
"layer" : "Building",
"icon_url" : "/v1/files/public/64e0a6d570a5f601e6d3accd/Letter_H_Manual.png",
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : [
],
"point_style" : "square"
}
],
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"visibility" : "private",
"customer_id" : "64e0a6d470a5f601e6d3acc7"
},
"uri" : "/v1/styles",
"status" : 201
}
Update the style
See also:
Styles - Create a style
Styles - Retrieve a style
PUT /v1/styles/64e0a6d570a5f601e6d3accf
Content-Type: application/json
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
}
],
"attributes" : [
{
"layer" : "House",
"color" : [
0,
0,
0
],
"icon_url" : null,
"point_style" : "circle"
},
{
"layer" : "School",
"color" : [
0,
0,
0
],
"icon_url" : null,
"point_style" : "circle"
},
{
"layer" : "Factory",
"color" : [
0,
0,
0
],
"icon_url" : null,
"point_style" : "circle"
},
{
"layer" : "Building",
"color" : [
0,
0,
0
],
"icon_url" : null,
"point_style" : "circle"
}
]
}
{
"style" : {
"id" : "64e0a6d570a5f601e6d3accf",
"created_at" : "2023-08-19T11:26:13.106Z",
"updated_at" : "2023-08-19T11:26:13.167236Z",
"deleted_at" : null,
"created_by" : "64e0a6d470a5f601e6d3acc5",
"updated_by" : "64e0a6d470a5f601e6d3acc5",
"deleted_by" : null,
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
}
],
"attributes" : [
{
"color" : [
0,
0,
0
],
"layer" : "House",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "School",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Factory",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Building",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
}
],
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"visibility" : "private",
"customer_id" : "64e0a6d470a5f601e6d3acc7"
},
"uri" : "/v1/styles/64e0a6d570a5f601e6d3accf",
"status" : 201
}
Retrieves the style
See also:
Styles - Create a style
GET /v1/styles/64e0a6d570a5f601e6d3accf
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"style" : {
"id" : "64e0a6d570a5f601e6d3accf",
"created_at" : "2023-08-19T11:26:13.106Z",
"updated_at" : "2023-08-19T11:26:13.167Z",
"deleted_at" : null,
"created_by" : "64e0a6d470a5f601e6d3acc5",
"updated_by" : "64e0a6d470a5f601e6d3acc5",
"deleted_by" : null,
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
}
],
"attributes" : [
{
"color" : [
0,
0,
0
],
"layer" : "House",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "School",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Factory",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Building",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
}
],
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"visibility" : "private",
"customer_id" : "64e0a6d470a5f601e6d3acc7"
},
"uri" : "/v1/styles/64e0a6d570a5f601e6d3accf",
"status" : 200
}
Retrieves the list of all private or public styles.
- visibility: "private", or "public"
If visibility is omitted from the query, both private and public styles are returned.
See also:
Styles - Create a style
GET /v1/styles?visibility=private
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"styles" : {
"metadata" : {
"uris" : {
"last" : "/v1/styles?page=1&perPage=100",
"self" : "/v1/styles",
"first" : "/v1/styles?page=1&perPage=100"
},
"pages" : 1,
"total_count" : 1,
"page" : 1,
"page_count" : 1,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/styles?page=1&perPage=100",
"self" : "https://api.mycumulus.com/v1/styles",
"first" : "https://api.mycumulus.com/v1/styles?page=1&perPage=100"
}
},
"instances" : [
{
"id" : "64e0a6d570a5f601e6d3accf",
"created_at" : "2023-08-19T11:26:13.106Z",
"updated_at" : "2023-08-19T11:26:13.167Z",
"deleted_at" : null,
"created_by" : "64e0a6d470a5f601e6d3acc5",
"updated_by" : "64e0a6d470a5f601e6d3acc5",
"deleted_by" : null,
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
}
],
"attributes" : [
{
"color" : [
0,
0,
0
],
"layer" : "House",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "School",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Factory",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Building",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
}
],
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"visibility" : "private",
"customer_id" : "64e0a6d470a5f601e6d3acc7"
}
]
},
"uri" : "/v1/styles",
"status" : 200
}
Returns true if the style is compatible with the given form. A style is compatible if the name and type of the indexes matches with fields in the form. In other words: the style can be applied to features of the given form.
See also:
Styles - Create a style
Styles - List of compatible styles
GET /v1/template/64e0a6d570a5f601e6d3acd0/style/64e0a6d570a5f601e6d3accf/compatible
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"compatible" : false,
"uri" : "/v1/template/64e0a6d570a5f601e6d3acd0/style/64e0a6d570a5f601e6d3accf/compatible",
"status" : 200
}
Returns all styles that are compatible with the given form. The list will return the "private" or "public" styles depending on the value of "visibility" in the query.
- visibility: "private", or "public"
If visibility is omitted from the query, both private and public styles are returned.
See also:
Styles - Create a style
Styles - Template and Style compatible
GET /v1/template/64e0a6d570a5f601e6d3acd0/styles?visibility=public
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"styles" : {
"metadata" : {
"uris" : {
"last" : "/v1/template/64e0a6d570a5f601e6d3acd0/styles?page=0&perPage=100",
"self" : "/v1/template/64e0a6d570a5f601e6d3acd0/styles",
"first" : "/v1/template/64e0a6d570a5f601e6d3acd0/styles?page=1&perPage=100"
},
"pages" : 0,
"total_count" : 0,
"page" : 1,
"page_count" : 0,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/template/64e0a6d570a5f601e6d3acd0/styles?page=0&perPage=100",
"self" : "https://api.mycumulus.com/v1/template/64e0a6d570a5f601e6d3acd0/styles",
"first" : "https://api.mycumulus.com/v1/template/64e0a6d570a5f601e6d3acd0/styles?page=1&perPage=100"
}
},
"instances" : [
]
},
"uri" : "/v1/template/64e0a6d570a5f601e6d3acd0/styles",
"status" : 200
}
Deletes the style
See also:
Styles - Create a style
DELETE /v1/styles/64e0a6d570a5f601e6d3accf
X-Auth-Token: f46f5e873b63a11bfa148d5140c3caacaf1fcaa2ea387ee69ccecc9b18d46b1fe9b5974dc5dff170f966c6b6eec27dcd333d3823d5c0769d41b2ad7fa774f03350dd30c9c9db12fc54fb3a6fb4938e4d28fdf8386377b33526857c0e23ee3fe335268cb51e4f2479e1f10fb49c7e0cdad43222903241bb99a57
{
"style" : {
"id" : "64e0a6d570a5f601e6d3accf",
"created_at" : "2023-08-19T11:26:13.106Z",
"updated_at" : "2023-08-19T11:26:13.167Z",
"deleted_at" : "2023-08-19T11:26:13.635993Z",
"created_by" : "64e0a6d470a5f601e6d3acc5",
"updated_by" : "64e0a6d470a5f601e6d3acc5",
"deleted_by" : "64e0a6d470a5f601e6d3acc5",
"indexes" : [
{
"name" : "Building",
"values" : [
"House",
"School",
"Factory",
null
]
}
],
"attributes" : [
{
"color" : [
0,
0,
0
],
"layer" : "House",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "School",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Factory",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
},
{
"color" : [
0,
0,
0
],
"layer" : "Building",
"icon_url" : null,
"line_style" : null,
"polygon_pattern" : null,
"autocad_block" : null,
"pythagoras_style" : null,
"point_style" : "circle"
}
],
"name" : "Style Sewage Inspection",
"description" : "Symbols used for Sewage Inspection",
"visibility" : "private",
"customer_id" : "64e0a6d470a5f601e6d3acc7"
},
"uri" : "/v1/styles/64e0a6d570a5f601e6d3accf",
"status" : 200
}
Uploads a new feature. If the user requesting the upload is a collaborator, and is not the owner of the project, he must be:
1. Member of the project and
2. Have the permission to create features.
Binary data (photos, etc>) are not stored in a feature. Rather they are uploaded as files. The feature will contain links to the files.
The field sequence_number in the request body is obligatory and must be a UUID. When missing or not unique, an error is returned. When the feature contains links to files, the feature_sequence_number used when uploading a file must be the same as the sequence_number of the feature. The sequence number can be used if the internet connection is not stable and may cause that the upload command needs to be sent again. When resending in case of communication errors, use the same sequence number. If not, the record will be stored twice on the server. Regarding file names see also: Files - Upload a private file
The order of the coordinates must be Latitude, Longitude, Elevation. Latitude and longitude are expressed in decimal degrees.
The field attributes should contain all attributes that are also in the template. If name and/or type do not match with the template, an error will be returned. If a field is not present the default value, if any, will be stored. Else the field is not stored in the database.
See also:
Files - Upload a private file
Templates - Create a form
Project/Members - Add a user to a project.
Project/Members - Grant permissions to collaborator
POST /v1/templates/64e0a6d670a5f601e6d3acda/features
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
Content-Type: application/json
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"geometry" : {
"type" : "Point",
"coordinates" : [
51.3021300000000,
4.88400400000000,
22.0000000000000,
9.87600000000000
]
},
"sequence_number" : "342734A7-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"attributes" : {
"T1 Field 1" : "F1 Value 1",
"T1 Field 2" : "F1 Value 2",
"T1 Field 3" : "F1 Value 3"
}
}
{
"feature" : {
"id" : "64e0a6d670a5f601e6d3acdc",
"sequence_number" : "342734A7-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.30213,
4.884004,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F1 Value 1",
"T1 Field 2" : "F1 Value 2",
"T1 Field 3" : "F1 Value 3"
},
"created_at" : "2023-08-19T11:31:40.683Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/features",
"status" : 201
}
Update a feature. If the user requesting the update is a collaborator, and is not the owner of the project, he must be:
1. Member of the project and
2. Have the permission to update features.
Regarding file names see also: Files - Upload a private file
The order of the coordinates must be Latitude, Longitude, Elevation. Latitude and longitude are expressed in decimal degrees.
The field attributes should contain all attributes that are also in the template. If name and/or type do not match with the template, an error will be returned. If a field is not present the default value, if any, will be stored. Else the field is not stored in the database.
See also:
Features - Upload a feature
Project/Members - Grant permissions to collaborator
PUT /v1/templates/64e0a6d670a5f601e6d3acda/features/64e0a6d670a5f601e6d3acdc
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
Content-Type: application/json
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"geometry" : {
"type" : "Point",
"coordinates" : [
6.22568200000000,
1.26083400000000,
22.0000000000000,
9.87600000000000
]
},
"template_id" : "64e0a6d670a5f601e6d3acda",
"attributes" : {
"T1 Field 1" : "F1 Upd Value 1",
"T1 Field 2" : "F1 Upd Value 2",
"T1 Field 3" : "F1 Upd Value 3"
}
}
{
"feature" : {
"id" : "64e0a6d670a5f601e6d3acdc",
"sequence_number" : "342734A7-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.225682,
1.260834,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F1 Upd Value 1",
"T1 Field 2" : "F1 Upd Value 2",
"T1 Field 3" : "F1 Upd Value 3"
},
"created_at" : "2023-08-19T11:26:14.326Z",
"updated_at" : "2023-08-19T11:34:43.266Z",
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : "64e0a6d570a5f601e6d3acd2",
"deleted_by" : null
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/features/64e0a6d670a5f601e6d3acdc",
"status" : 200
}
Returns the number of features.
See also:
Features - Upload a feature
Features - Retrieve the list of all features
GET /v1/templates/64e0a6d670a5f601e6d3acda/features/count/
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"number_of_features" : 3
}
Retrieve the list of all features.
See also:
Features - Upload a feature
Features - Number of features
GET /v1/templates/64e0a6d670a5f601e6d3acda/features?page1?perPage=100
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"features" : {
"metadata" : {
"uris" : {
"last" : "/v1/templates/64e0a6d670a5f601e6d3acda/features?page=1&perPage=500",
"self" : "/v1/templates/64e0a6d670a5f601e6d3acda/features",
"first" : "/v1/templates/64e0a6d670a5f601e6d3acda/features?page=1&perPage=500"
},
"pages" : 1,
"total_count" : 3,
"page" : 1,
"page_count" : 3,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3acda/features?page=1&perPage=500",
"self" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3acda/features",
"first" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3acda/features?page=1&perPage=500"
}
},
"instances" : [
{
"id" : "64e0a6d670a5f601e6d3acde",
"sequence_number" : "342734A9-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.312553,
4.88304,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F3 Value 1",
"T1 Field 2" : "F3 Value 2",
"T1 Field 3" : "F3 Value 3"
},
"created_at" : "2023-08-19T11:26:14.459Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d670a5f601e6d3acdd",
"sequence_number" : "342734A8-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.312572,
4.875058,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F2 Value 1",
"T1 Field 2" : "F2 Value 2",
"T1 Field 3" : "F2 Value 3"
},
"created_at" : "2023-08-19T11:26:14.414Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d670a5f601e6d3acdc",
"sequence_number" : "342734A7-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.225682,
1.260834,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F1 Upd Value 1",
"T1 Field 2" : "F1 Upd Value 2",
"T1 Field 3" : "F1 Upd Value 3"
},
"created_at" : "2023-08-19T11:26:14.326Z",
"updated_at" : "2023-08-19T11:26:14.509Z",
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : "64e0a6d570a5f601e6d3acd2",
"deleted_by" : null
}
]
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/features",
"status" : 200
}
Retrieve a feature.
See also:
Features - Upload a feature
GET /v1/templates/64e0a6d670a5f601e6d3acda/features/64e0a6d670a5f601e6d3acdc
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"feature" : {
"id" : "64e0a6d670a5f601e6d3acdc",
"sequence_number" : "342734A7-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.225682,
1.260834,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F1 Upd Value 1",
"T1 Field 2" : "F1 Upd Value 2",
"T1 Field 3" : "F1 Upd Value 3"
},
"created_at" : "2023-08-19T11:26:14.326Z",
"updated_at" : "2023-08-19T11:26:14.509Z",
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : "64e0a6d570a5f601e6d3acd2",
"deleted_by" : null
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/features/64e0a6d670a5f601e6d3acdc",
"status" : 200
}
One feature is duplicated in the same template where it is stored in.
See also:
Features - Upload a feature
POST /v1/templates/64e0a6d670a5f601e6d3acda/feature/duplicate
Content-Type: application/json
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"feature_id" : "64e0a6d670a5f601e6d3acdc"
}
{
"feature" : {
"id" : "64e0a6d670a5f601e6d3acdf",
"sequence_number" : "de736050-5878-4928-a2d4-d69e0657ca2b",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.225682,
1.260834,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F1 Upd Value 1",
"T1 Field 2" : "F1 Upd Value 2",
"T1 Field 3" : "F1 Upd Value 3"
},
"created_at" : "2023-08-19T11:37:15.874Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/feature/duplicate",
"status" : 201
}
Multiple features or duplicated in the same template where they are stored in, or pasted in the template specified by the templateId in the url.
A collaborator must have write access to the given template.The parameter 'paste_features' must be true when the templateId in the url is different from the templateId of the features.
See also:
Features - Upload a feature
POST /v1/templates/64e0a6d670a5f601e6d3acdb/features/duplicate
Content-Type: application/json
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"feature_ids" : [
"64e0a6d670a5f601e6d3acdd",
"64e0a6d670a5f601e6d3acde"
],
"paste_features" : true
}
{
"features" : [
{
"id" : "64e0a6d670a5f601e6d3ace0",
"sequence_number" : "bdc5a8a8-116b-4d0e-bf21-e7731498d790",
"template_id" : "64e0a6d670a5f601e6d3acdb",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.312572,
4.875058,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F2 Value 1",
"T1 Field 2" : "F2 Value 2",
"T1 Field 3" : "F2 Value 3"
},
"created_at" : "2023-08-19T11:38:05.223Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d670a5f601e6d3ace1",
"sequence_number" : "933931dc-df79-43e5-8102-4e63c8b598b3",
"template_id" : "64e0a6d670a5f601e6d3acdb",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.312553,
4.88304,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F3 Value 1",
"T1 Field 2" : "F3 Value 2",
"T1 Field 3" : "F3 Value 3"
},
"created_at" : "2023-08-19T11:38:15.090Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
}
],
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acdb/features/duplicate",
"status" : 201
}
Delete a feature. If the user requesting the delete is a collaborator, and is not the owner of the project, he must be:
1. Member of the project and
2. Have the permission to delete features.
See also:
Features - Upload a feature
Project/Members - Add a user to a project.
Project/Members - Grant permissions to collaborator
DELETE /v1/templates/64e0a6d670a5f601e6d3acda/features/64e0a6d670a5f601e6d3acdc
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"feature" : {
"id" : "64e0a6d670a5f601e6d3acdc",
"sequence_number" : "342734A7-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.225682,
1.260834,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F1 Upd Value 1",
"T1 Field 2" : "F1 Upd Value 2",
"T1 Field 3" : "F1 Upd Value 3"
},
"created_at" : "2023-08-19T11:26:14.326Z",
"updated_at" : "2023-08-19T11:26:14.509Z",
"deleted_at" : "2023-08-19T11:26:14.771257Z",
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : "64e0a6d570a5f601e6d3acd2",
"deleted_by" : "64e0a6d570a5f601e6d3acd2"
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/features/64e0a6d670a5f601e6d3acdc",
"status" : 200
}
Delete a set of features. The Ids of features to be deleted are listed in the Request Body.
If the user requesting the delete is a collaborator, and is not the owner of the project, he must be:
1. Member of the project and
2. Have the permission to delete features.
See also:
Features - Upload a feature
Project/Members - Add a user to a project.
Project/Members - Grant permissions to collaborator
DELETE /v1/templates/64e0a6d670a5f601e6d3acda/features
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
Content-Type: application/json
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"ids" : [
"64e0a6d670a5f601e6d3acdd",
"64e0a6d670a5f601e6d3acde"
]
}
{
"features" : {
"metadata" : {
"uris" : {
},
"pages" : 0,
"total_count" : 0,
"page" : 0,
"page_count" : 0,
"absolute_uris" : {
}
},
"instances" : [
{
"id" : "64e0a6d670a5f601e6d3acdd",
"sequence_number" : "342734A8-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.312572,
4.875058,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F2 Value 1",
"T1 Field 2" : "F2 Value 2",
"T1 Field 3" : "F2 Value 3"
},
"created_at" : "2023-08-19T11:26:14.414Z",
"updated_at" : null,
"deleted_at" : "2023-08-19T11:26:14.818666Z",
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : "64e0a6d570a5f601e6d3acd2"
},
{
"id" : "64e0a6d670a5f601e6d3acde",
"sequence_number" : "342734A9-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3acda",
"geometry" : {
"type" : "Point",
"coordinates" : [
51.312553,
4.88304,
22.0,
0.0
]
},
"attributes" : {
"T1 Field 1" : "F3 Value 1",
"T1 Field 2" : "F3 Value 2",
"T1 Field 3" : "F3 Value 3"
},
"created_at" : "2023-08-19T11:26:14.459Z",
"updated_at" : null,
"deleted_at" : "2023-08-19T11:26:14.821924Z",
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : "64e0a6d570a5f601e6d3acd2"
}
]
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3acda/features",
"status" : 200
}
Search the given text in all string fields in the features of a given template. The template body contains the text to be searched for (not JSON).
See also:
Features - Search extensive
Features - Search text in all projects/templates
POST /v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
Content-Type: text/plain; charset=utf-8
R&D
{
"features" : {
"metadata" : {
"uris" : {
"last" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch?page=1&perPage=500",
"self" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch",
"first" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch?page=1&perPage=500"
},
"pages" : 1,
"total_count" : 4,
"page" : 1,
"page_count" : 4,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch?page=1&perPage=500",
"self" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch",
"first" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch?page=1&perPage=500"
}
},
"instances" : [
{
"id" : "64e0a6d770a5f601e6d3ace7",
"sequence_number" : "342734AE-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Michel",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.098Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d770a5f601e6d3ace6",
"sequence_number" : "342734AD-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Boris",
"Function" : "Testing & Deployment",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.052Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d770a5f601e6d3ace5",
"sequence_number" : "342734AC-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Ishak",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.009Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d670a5f601e6d3ace4",
"sequence_number" : "342734AB-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Matthias",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:14.959Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
}
]
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/textsearch",
"status" : 200
}
Search the given text in all string fields in the features of all templates of all projects the user has access to. The template body contains the text to be searched for (not JSON).
See also:
Features - Search extensive
POST /v1/globalsearch/features
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
Content-Type: text/plain; charset=utf-8
R&D
{
"features" : [
{
"id" : "64e0a6d770a5f601e6d3aceb",
"sequence_number" : "342734B0-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d770a5f601e6d3ace9",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Sergey",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.442Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d770a5f601e6d3ace7",
"sequence_number" : "342734AE-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Michel",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.098Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d770a5f601e6d3ace6",
"sequence_number" : "342734AD-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Boris",
"Function" : "Testing & Deployment",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.052Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d770a5f601e6d3ace5",
"sequence_number" : "342734AC-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Ishak",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.009Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d670a5f601e6d3ace4",
"sequence_number" : "342734AB-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Matthias",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:14.959Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
}
],
"projects" : [
{
"id" : "64e0a6d770a5f601e6d3ace8",
"name" : "My Organisation",
"description" : "Data about organisation",
"image_file_url" : null,
"template_ids" : [
"64e0a6d770a5f601e6d3ace9"
],
"created_at" : "2023-08-19T11:26:15.345Z",
"updated_at" : "2023-08-19T11:26:15.380Z",
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : "64e0a6d570a5f601e6d3acd2",
"deleted_by" : null,
"customer_id" : "64e0a6d570a5f601e6d3acd4",
"project_class" : "project",
"visibility" : "private",
"archived" : false
},
{
"id" : "64e0a6d670a5f601e6d3acd9",
"name" : "Test Project",
"description" : "Description of Test Project",
"image_file_url" : null,
"template_ids" : [
"64e0a6d670a5f601e6d3acda",
"64e0a6d670a5f601e6d3acdb",
"64e0a6d670a5f601e6d3ace2"
],
"created_at" : "2023-08-19T11:26:14.187Z",
"updated_at" : "2023-08-19T11:26:14.865Z",
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : "64e0a6d570a5f601e6d3acd2",
"deleted_by" : null,
"customer_id" : "64e0a6d570a5f601e6d3acd4",
"project_class" : "project",
"visibility" : "private",
"archived" : false
}
],
"templates" : [
{
"id" : "64e0a6d770a5f601e6d3ace9",
"project_id" : "64e0a6d770a5f601e6d3ace8",
"name" : "Staff Development",
"description" : "List of employees",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Name",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Function",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Department",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "stringfield",
"name" : "Name",
"label" : "Name",
"description" : "0",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Function",
"label" : "Function",
"description" : "0",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Department",
"label" : "Department",
"description" : "0",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:15.378Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
{
"id" : "64e0a6d670a5f601e6d3ace2",
"project_id" : "64e0a6d670a5f601e6d3acd9",
"name" : "Staff",
"description" : "List of employees",
"image_file_url" : null,
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "Name",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Function",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Department",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "stringfield",
"name" : "Name",
"label" : "Name",
"description" : "0",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Function",
"label" : "Function",
"description" : "0",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
},
{
"_class" : "stringfield",
"name" : "Department",
"label" : "Department",
"description" : "0",
"enabled" : false,
"visible" : false,
"required" : true,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : null
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:14.863Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
}
]
}
Extensive search in all the features of a template. The query is in the Request Body in JSON format. When the request body contains multiple name, value pairs, all those conditions must be met.The query may contain operators to specify if values should be equal, greater than, less than, etc. The use of those operators will be documented later.
See also:
Features - Search text
POST /v1/templates/64e0a6d670a5f601e6d3ace2/features/search
Content-Type: application/json
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
X-Working-Project-Id: 64e0a6d670a5f601e6d3acd9
{
"Function" : "Developer",
"Department" : "R&D"
}
{
"features" : {
"metadata" : {
"uris" : {
"last" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/search?page=1&perPage=500",
"self" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/search",
"first" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/search?page=1&perPage=500"
},
"pages" : 1,
"total_count" : 3,
"page" : 1,
"page_count" : 3,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3ace2/features/search?page=1&perPage=500",
"self" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3ace2/features/search",
"first" : "https://api.mycumulus.com/v1/templates/64e0a6d670a5f601e6d3ace2/features/search?page=1&perPage=500"
}
},
"instances" : [
{
"id" : "64e0a6d770a5f601e6d3ace7",
"sequence_number" : "342734AE-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Michel",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.098Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d770a5f601e6d3ace5",
"sequence_number" : "342734AC-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Ishak",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:15.009Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
},
{
"id" : "64e0a6d670a5f601e6d3ace4",
"sequence_number" : "342734AB-3E83-11EE-B700-BC9A78563412",
"template_id" : "64e0a6d670a5f601e6d3ace2",
"geometry" : {
"type" : "Point",
"coordinates" : [
6.168548,
1.234305,
0.0,
0.0
]
},
"attributes" : {
"Name" : "Matthias",
"Function" : "Developer",
"Department" : "R&D"
},
"created_at" : "2023-08-19T11:26:14.959Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null
}
]
},
"uri" : "/v1/templates/64e0a6d670a5f601e6d3ace2/features/search",
"status" : 200
}
Imports features in an existing or in a new template. The request body contains the data, in CSV format, Base64 encoded.The template is specified by it's name. If the template does not exist yet, a new template with that name is generated.In that case, the request body must contain for each field (1) the type, (2) the name and (3) the label. When the CSV contains the coordinates of a point, the CRS of the coordinates must be given and in the array "coordinate_columns" the columns (starting from 1) of the coordinates. For a 2D point, the array will contain 2 elements.
POST /v1/imports/data
Content-Type: application/json
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
{
"template" : {
"name" : "Points",
"description" : "Form created by import",
"project_id" : "64e0a6d670a5f601e6d3acd9"
},
"data" : {
"base64_encoded_content" : "77u/UG9pbnROciwgWCwgWSwgWiwgQ29kZQ0KMTAwMCwgNTEuNzc0NjEyODcsNC42NDcwODUwOSw0OC4wMCxQb2ludDENCjEwMDEsIDUxLjc3NSw0LjY0Niw0OS4wMCxQb2ludCAyDQo=",
"encoding" : "UTF8",
"type" : "CSV",
"data_separator" : ",",
"decimal_separator" : ".",
"geometry" : "Point",
"coordinate_columns" : [
2,
3,
4
],
"crs" : "Geodetic",
"fields" : [
{
"_class" : "stringfield",
"name" : "PointNr",
"label" : "Point Number"
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Code"
}
]
}
}
{
"template" : {
"id" : "64e0a6d770a5f601e6d3acec",
"project_id" : "64e0a6d670a5f601e6d3acd9",
"name" : "Points",
"description" : "Form created by import",
"image_file_url" : "",
"feature" : {
"geometry_type" : "Point",
"attributes" : [
{
"_class" : "attribute",
"name" : "PointNr",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
},
{
"_class" : "attribute",
"name" : "Code",
"type" : "string",
"default_value" : null,
"restrictions" : [
]
}
]
},
"form" : {
"fields" : [
{
"_class" : "stringfield",
"name" : "PointNr",
"label" : "Point Number",
"description" : null,
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : ""
},
{
"_class" : "stringfield",
"name" : "Code",
"label" : "Code",
"description" : null,
"enabled" : true,
"visible" : true,
"required" : false,
"use_previous_value" : false,
"event_actions" : null,
"default_value_expression" : null,
"constraints" : [
],
"default_value" : ""
}
]
},
"map_style" : null,
"template" : false,
"created_at" : "2023-08-19T11:26:15.654568Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6d570a5f601e6d3acd2",
"updated_by" : null,
"deleted_by" : null,
"visibility" : "private",
"is_template" : false,
"default_style_id" : null
},
"features" : [
"2 features inserted successfully"
],
"uri" : "/v1/imports/data",
"status" : 201
}
Imports an IMKL (B and NL) file. The request body contains the XML or ZIP-file, Base64 encoded.In the given project, new templates are created based on the Project Template specified by project_template_id.For more information consult the IMKL documentation.
POST /v1/imports/imkl
Content-Type: application/json
X-Auth-Token: d7505eb78135f22fa92b340a6d3551df367b57b1d3efa180a74322b7c729218cc47c2a8a47d9ad97c1de463d7a80f5f189fc9e23b9df7cd8f78beef299db4442b8b93b231b6e07bdb6dda55a51fbf9e6b13bca3bda6ed3974969536f46477a81a96f097d0b88ae734d6b6cff8a53d2d56c7a1c6936cdfe7186a5912b1
{
"project_id" : "64e0a6d670a5f601e6d3acd9",
"model" : "imkl_nl",
"base64_encoded_content" : "Base64Data",
"encoding" : "UTF8",
"type" : "xml"
}
{
"error" : {
"code" : 78,
"message" : "invalid 'base64' string."
},
"uri" : "/v1/imports/imkl",
"status" : 400
}
Creates a new report template. A report template can be either used by all users in the organisation and with any form (visibleTo = all_users), or the report template is linked with one or more forms (visibleTo = some_forms).This is the first step to create a customized report template. Afterwards the html files defining the layout of the report must still be uploaded.
See also:
Report Templates - Update the report template
Report Templates - Delete a report template
Report Templates - Retrieve the list of all report templates
Report Templates - Retrieve a report template
POST /v1/reporttemplates?visibleTo=all_users
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
Content-Type: application/json
{
"name" : "My Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4"
}
{
"report_template" : {
"id" : "64e0a6e570a5f601e6d3acf7",
"name" : "My Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "all_users",
"created_at" : "2023-08-19T11:26:29.362544Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
"uri" : "/v1/reporttemplates",
"status" : 201
}
Creates a new report template. A report template can be either used by all users in the organisation and with any form (visibleTo = all_users), or the report template is linked with one or more forms (visibleTo = some_forms).This is the first step to create a customized report template. Afterwards the html files defining the layout of the report must still be uploaded.
See also:
Report Templates - Update the report template
Report Templates - Delete a report template
Report Templates - Retrieve the list of all report templates
Report Templates - Retrieve a report template
POST /v1/reporttemplates?visibleTo=some_forms
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
Content-Type: application/json
{
"name" : "Private Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"linked_templates" : [
],
"orientation" : "portrait",
"default_page_size" : "A4"
}
{
"report_template" : {
"id" : "64e0a6e570a5f601e6d3acf8",
"name" : "Private Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "some_forms",
"linked_templates" : [
],
"created_at" : "2023-08-19T11:26:29.424006Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : null,
"deleted_by" : null,
"description" : null
},
"uri" : "/v1/reporttemplates",
"status" : 201
}
Update the report template. The Request Body may contain only the properties to be updated. However it's advised to send the complete updated template again.
See also:
Report Templates - Create a report template
Report Templates - Retrieve a report template
PUT /v1/reporttemplates/64e0a6e570a5f601e6d3acf7
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
Content-Type: application/json
{
"name" : "My Updated Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3"
}
{
"report_template" : {
"id" : "64e0a6e570a5f601e6d3acf7",
"name" : "My Updated Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "all_users",
"created_at" : "2023-08-19T11:26:29.362Z",
"updated_at" : "2023-08-19T11:26:29.462277Z",
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : "64e0a6e570a5f601e6d3acf0",
"deleted_by" : null,
"description" : ""
},
"uri" : "/v1/reporttemplates/64e0a6e570a5f601e6d3acf7",
"status" : 200
}
Retrieve the list of all report templates owned by the given user.
See also:
Report Templates - Create a report template
GET /v1/reporttemplates
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
{
"report_templates" : {
"metadata" : {
"uris" : {
"last" : "/v1/reporttemplates?page=1&perPage=500",
"self" : "/v1/reporttemplates",
"first" : "/v1/reporttemplates?page=1&perPage=500"
},
"pages" : 1,
"total_count" : 2,
"page" : 1,
"page_count" : 2,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/reporttemplates?page=1&perPage=500",
"self" : "https://api.mycumulus.com/v1/reporttemplates",
"first" : "https://api.mycumulus.com/v1/reporttemplates?page=1&perPage=500"
}
},
"instances" : [
{
"id" : "64e0a6e570a5f601e6d3acf8",
"name" : "Private Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "some_forms",
"linked_templates" : [
],
"created_at" : "2023-08-19T11:26:29.424Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : null,
"deleted_by" : null,
"description" : null
},
{
"id" : "64e0a6e570a5f601e6d3acf7",
"name" : "My Updated Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "all_users",
"created_at" : "2023-08-19T11:26:29.362Z",
"updated_at" : "2023-08-19T11:26:29.462Z",
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : "64e0a6e570a5f601e6d3acf0",
"deleted_by" : null,
"description" : ""
}
]
},
"uri" : "/v1/reporttemplates",
"status" : 200
}
The public report templates are generic and available to all MyCumulus users.
See also:
Report Templates - Create a public report template. (Type mc_admin and all_mc_users)
GET /v1/public/reporttemplates?page=1&perPage=10
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
{
"report_templates" : {
"metadata" : {
"uris" : {
"next" : "/v1/public/reporttemplates?page=2&perPage=10",
"last" : "/v1/public/reporttemplates?page=2&perPage=10",
"self" : "/v1/public/reporttemplates",
"first" : "/v1/public/reporttemplates?page=1&perPage=10"
},
"pages" : 2,
"total_count" : 11,
"page" : 1,
"page_count" : 10,
"absolute_uris" : {
"next" : "https://api.mycumulus.com/v1/public/reporttemplates?page=2&perPage=10",
"last" : "https://api.mycumulus.com/v1/public/reporttemplates?page=2&perPage=10",
"self" : "https://api.mycumulus.com/v1/public/reporttemplates",
"first" : "https://api.mycumulus.com/v1/public/reporttemplates?page=1&perPage=10"
}
},
"instances" : [
{
"id" : "64e0a6e570a5f601e6d3acfb",
"name" : "Public Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf9",
"visible_to" : "all_mc_users",
"created_at" : "2023-08-19T11:26:29.657Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf9",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b519812e4b06c1b130c5ef3",
"name" : "MyCumulus Demo",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T08:06:42.496Z",
"updated_at" : "2020-04-28T16:04:52.118Z",
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : "5b50d939e4b06c1b130c5964",
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b5197b2e4b06c1b130c5ef0",
"name" : "MyCumulus A3 Landscape",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T08:05:06.492Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b519751e4b06c1b130c5eed",
"name" : "MyCumulus A3 Portrait",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T08:03:29.316Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b5196f2e4b06c1b130c5eea",
"name" : "MyCumulus A4 Landscape",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T08:01:54.389Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b51968ce4b06c1b130c5ee7",
"name" : "MyCumulus A4 Portrait",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T08:00:12.676Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b51962be4b06c1b130c5ee4",
"name" : "Standard A3 Landscape",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T07:58:35.601Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b5195a1e4b06c1b130c5edf",
"name" : "Standard A3 Portrait",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T07:56:17.091Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b51954ee4b06c1b130c5edd",
"name" : "Standard A4 Landscape",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T07:54:54.588Z",
"updated_at" : null,
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : null,
"deleted_by" : null,
"description" : ""
},
{
"id" : "5b519403e4b06c1b130c5ed3",
"name" : "Standard A4 Portrait",
"place_holders" : [
{
"CompanyName" : null
},
{
"Address" : null
},
{
"Reporter" : null
},
{
"Date" : null
},
{
"TableTitle" : null
},
{
"PhoneNumber" : null
},
{
"Email" : null
},
{
"Website" : null
}
],
"orientation" : "portrait",
"default_page_size" : "A4",
"template_preview_url" : null,
"user_id" : "5b50d939e4b06c1b130c5964",
"visible_to" : "all_mc_users",
"created_at" : "2018-07-20T07:49:23.204Z",
"updated_at" : "2018-07-20T07:53:37.146Z",
"deleted_at" : null,
"created_by" : "5b50d939e4b06c1b130c5964",
"updated_by" : "5b50d939e4b06c1b130c5964",
"deleted_by" : null,
"description" : ""
}
]
},
"uri" : "/v1/public/reporttemplates",
"status" : 200
}
Retrieves a report template.
See also:
Report Templates - Create a report template
GET /v1/reporttemplates/64e0a6e570a5f601e6d3acf7
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
{
"report_template" : {
"id" : "64e0a6e570a5f601e6d3acf7",
"name" : "My Updated Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "all_users",
"created_at" : "2023-08-19T11:26:29.362Z",
"updated_at" : "2023-08-19T11:26:29.462Z",
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : "64e0a6e570a5f601e6d3acf0",
"deleted_by" : null,
"description" : ""
},
"uri" : "/v1/reporttemplates/64e0a6e570a5f601e6d3acf7",
"status" : 200
}
Deletes a report template.
See also:
Report Templates - Create a report template
DELETE /v1/reporttemplates/64e0a6e570a5f601e6d3acf7
X-Auth-Token: e9d0236c9b3b684e764f65d4b789b60c222bf6152b7c6a3d44855b3952c77de9d0ce5e8126cb20d6638aeb15a96dccf45ad3faede3bce82fe95b37afb23c539011fb381fec17e3f891d4ababc0b93e522af2937b2280d9fb3e784e175b0ea2c1adee3a5cfe296160e89d41df32d17c855d9f466dc0b08352d75e53d75
{
"report_template" : {
"id" : "64e0a6e570a5f601e6d3acf7",
"name" : "My Updated Report Template",
"place_holders" : [
{
"User Name" : "Fons"
},
{
"Date" : null
}
],
"orientation" : "landscape",
"default_page_size" : "A3",
"template_preview_url" : null,
"user_id" : "64e0a6e570a5f601e6d3acf0",
"visible_to" : "all_users",
"created_at" : "2023-08-19T11:26:29.362Z",
"updated_at" : "2023-08-19T11:26:29.462Z",
"deleted_at" : null,
"created_by" : "64e0a6e570a5f601e6d3acf0",
"updated_by" : "64e0a6e570a5f601e6d3acf0",
"deleted_by" : null,
"description" : ""
},
"uri" : "/v1/reporttemplates/64e0a6e570a5f601e6d3acf7",
"status" : 200
}
Request to create a report. The request body must contain the format (either CSV, HTLM, PDF or JSON) of the report, the type, the template (with report template id and the names/values of the place holders), and queries containing the required information to filter and sort the data that must come in the report. Details about the MongoDB aggregation stages are out of the scope of this document. The $project stage is twice in the pipeline. When following this guideline, the fields will be ordered in the given sequence. The names in the headers, in case "type" : "table", will be the names used in the 2nd $project stage, the text after 'attributes.'. The column titles used by the example will be "Column 1", "Column 2", and "Column 3"
The response contains a.o. an id that allows to request the status (pending or generated) of the request: Create Report - Get the status of the report generation
See also:
Report Templates - Create a report template
Create Report - Get the status of the report generation
Create Report - Get the list of generated reports
POST /v1/reports/generate
X-Auth-Token: 6d978ffb658aab3a3fae10109ba4a5faa30e441c114d972abe547386d548effd279f47bd99dc229da083e6671a911992a991f9e4f9eacbd7c11b82fca1e8979feac336ee9fab3eba35fb4614eba2f2b1ba25c169c7e7cda9afc37821de112737d8995e4aa196cefa460edde4cc73db65189bc242d675986a180eac82d55
Content-Type: application/json
{
"format" : [
"html"
],
"type" : "table",
"templates" : [
{
"template_id" : "64e0a6e670a5f601e6d3ad04",
"place_holders" : [
{
"CompanyName" : "MyCumulus inc."
},
{
"Date" : "25 September 2016"
},
{
"TableTitle" : "Example Report"
}
]
}
],
"queries" : [
{
"collection" : "features",
"stages" : [
{
"$match" : {
"$and" : [
{
"template_id" : "64e0a6e670a5f601e6d3ad06"
}
]
}
},
{
"$sort" : {
"_id" : 1
}
},
{
"$project" : {
"_id" : 0,
"T1 Field 1" : "$attributes.T1 Field 1",
"T1 Field 2" : "$attributes.T1 Field 2",
"T1 Field 3" : "$attributes.T1 Field 3"
}
},
{
"$project" : {
"attributes.Column 1" : "$T1 Field 1",
"attributes.Column 2" : "$T1 Field 2",
"attributes.Column 3" : "$T1 Field 3"
}
}
]
}
]
}
{
"file" : {
"id" : "64e0a6e670a5f601e6d3ad11",
"filename" : null,
"download_url" : null,
"downloaded" : false,
"user_id" : "64e0a6e670a5f601e6d3acfd",
"report_status" : "pending"
},
"uri" : "/v1/reports/generate",
"status" : 200
}
Requests the status of the report generation. When report_status = "generated", the field download_url contains the URL to download the file either automatically, see Report Templates - Retrieve the list of folders containing the template files or by using the URL in a browser.
See also:
Create Report - Create a report
GET /v1/report_status/64e0a6e670a5f601e6d3ad11
X-Auth-Token: 6d978ffb658aab3a3fae10109ba4a5faa30e441c114d972abe547386d548effd279f47bd99dc229da083e6671a911992a991f9e4f9eacbd7c11b82fca1e8979feac336ee9fab3eba35fb4614eba2f2b1ba25c169c7e7cda9afc37821de112737d8995e4aa196cefa460edde4cc73db65189bc242d675986a180eac82d55
Content-Type: application/json
{
"file" : {
"id" : "64e0a6e670a5f601e6d3ad11",
"filename" : "Test Project -- Template 1 2023-08-19 11.26.30.html",
"download_url" : "/v1/files/public/64e0a6e670a5f601e6d3ad11/Test Project -- Template 1 2023-08-19 11.26.30.html",
"downloaded" : false,
"user_id" : "64e0a6e670a5f601e6d3acfd",
"report_status" : "generated"
},
"uri" : "/v1/report_status/64e0a6e670a5f601e6d3ad11",
"status" : 200
}
Gets the list of the generated reports that are still available on the server. This list contains all reports that are available for downloading. The response contains a.o. the URL to download the report and an indication if the report has already been downloaded.
See also:
Create Report - Create a report
GET /v1/reports/64e0a6e670a5f601e6d3acfd
X-Auth-Token: 6d978ffb658aab3a3fae10109ba4a5faa30e441c114d972abe547386d548effd279f47bd99dc229da083e6671a911992a991f9e4f9eacbd7c11b82fca1e8979feac336ee9fab3eba35fb4614eba2f2b1ba25c169c7e7cda9afc37821de112737d8995e4aa196cefa460edde4cc73db65189bc242d675986a180eac82d55
Content-Type: application/json
{
"public_files" : {
"metadata" : {
"uris" : {
"last" : "/v1/reports/64e0a6e670a5f601e6d3acfd?page=1&perPage=1",
"self" : "/v1/reports/64e0a6e670a5f601e6d3acfd",
"first" : "/v1/reports/64e0a6e670a5f601e6d3acfd?page=1&perPage=1"
},
"pages" : 1,
"total_count" : 1,
"page" : 1,
"page_count" : 1,
"absolute_uris" : {
"last" : "https://api.mycumulus.com/v1/reports/64e0a6e670a5f601e6d3acfd?page=1&perPage=1",
"self" : "https://api.mycumulus.com/v1/reports/64e0a6e670a5f601e6d3acfd",
"first" : "https://api.mycumulus.com/v1/reports/64e0a6e670a5f601e6d3acfd?page=1&perPage=1"
}
},
"instances" : [
{
"id" : "64e0a6e670a5f601e6d3ad11",
"filename" : "Test Project -- Template 1 2023-08-19 11.26.30.html",
"download_url" : "/v1/files/public/64e0a6e670a5f601e6d3ad11/Test Project -- Template 1 2023-08-19 11.26.30.html",
"downloaded" : false,
"user_id" : "64e0a6e670a5f601e6d3acfd",
"report_status" : "generated"
}
]
},
"uri" : "/v1/reports/64e0a6e670a5f601e6d3acfd",
"status" : 200
}
Sets in the list of generated reports the indication that the report has been downloaded.
See also:
Create Report - Create a report
Create Report - Get the list of generated reports
PUT /v1/reports/64e0a6e670a5f601e6d3ad11
X-Auth-Token: 6d978ffb658aab3a3fae10109ba4a5faa30e441c114d972abe547386d548effd279f47bd99dc229da083e6671a911992a991f9e4f9eacbd7c11b82fca1e8979feac336ee9fab3eba35fb4614eba2f2b1ba25c169c7e7cda9afc37821de112737d8995e4aa196cefa460edde4cc73db65189bc242d675986a180eac82d55
{
"file" : {
"id" : "64e0a6e670a5f601e6d3ad11",
"filename" : "Test Project -- Template 1 2023-08-19 11.26.30.html",
"download_url" : null,
"downloaded" : true,
"user_id" : "64e0a6e670a5f601e6d3acfd",
"report_status" : "generated"
},
"uri" : "/v1/reports/64e0a6e670a5f601e6d3ad11",
"status" : 200
}
Deletes the report from the list of generated reports. Once the report is removed from the list, it is not available on the server anymore.
See also:
Create Report - Create a report
Create Report - Get the list of generated reports
DELETE /v1/reports/64e0a6e670a5f601e6d3ad11
X-Auth-Token: 6d978ffb658aab3a3fae10109ba4a5faa30e441c114d972abe547386d548effd279f47bd99dc229da083e6671a911992a991f9e4f9eacbd7c11b82fca1e8979feac336ee9fab3eba35fb4614eba2f2b1ba25c169c7e7cda9afc37821de112737d8995e4aa196cefa460edde4cc73db65189bc242d675986a180eac82d55
{
"file" : {
"id" : "64e0a6e670a5f601e6d3ad11",
"filename" : "Test Project -- Template 1 2023-08-19 11.26.30.html",
"download_url" : "/v1/files/public/64e0a6e670a5f601e6d3ad11/Test Project -- Template 1 2023-08-19 11.26.30.html",
"downloaded" : true,
"user_id" : "64e0a6e670a5f601e6d3acfd",
"report_status" : "generated"
},
"uri" : "/v1/reports/64e0a6e670a5f601e6d3ad11",
"status" : 200
}
Upload a private file. A private file may only be used in combination with a feature. If no feature with the corresponding feature_sequence_number is uploaded, the private file will be removed automatically after one week. A private file is only accessible with authentication of the owner.
The feature_sequence_number is a UUID and must match with the sequence_number of the feature. See Features - Upload a feature. The combination of file_sequence_number and feature_sequence_number must be unique It's the responsibility of the client to make the name unique.
The download_url in the response, allows any user with the right permissions (e.g. collaborator having access to the feature) to download the file.
The Request Body contains the fields:
1. filename : the name of the file. Although the combination with file_sequence_number and feature_sequence_number must be unique, it's recommended that the name is unique for the user. After all, the project the file belongs to is not taken into account.
2. file_sequence_number : Is used to guaranty that the file is not stored twice on the server in case the upload command has to be repeated in case of a communication error.
3. feature_sequence_number : The value is the sequence_number of a feature the file is linked to. The feature_sequence_number is a UUID and links features with files.
See also:
Features - Upload a feature
Files - Download a private file
Files - Delete a private file
POST /v1/files
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
Content-Type: application/json
X-Working-Project-Id: 64e0a6e970a5f601e6d3ad1c
{
"filename" : "Photo1.jpg",
"file_sequence_number" : "File_Sequence_Number",
"feature_sequence_number" : "3DA710B4-3E83-11EE-B700-BC9A78563412",
"base64_encoded_content" : "Removed base64_encoded_content from report"
}
{
"file" : {
"fileSequenceNumber" : "File_Sequence_Number",
"id" : "64e0a6e970a5f601e6d3ad1d",
"filename" : "Photo1.jpg",
"download_url" : "/v1/files/64e0a6e970a5f601e6d3ad1d/Photo1.jpg",
"downloaded" : false,
"feature_sequence_number" : "3DA710B4-3E83-11EE-B700-BC9A78563412",
"user_id" : "64e0a6e970a5f601e6d3ad15",
"report_file" : false,
"report_status" : null
},
"uri" : "/v1/files",
"status" : 200
}
Check if a private file exists. This command is introduced to check if a file of a feature already exists in case commnunication errors aborted uploading.
The Request Body is identical to the request body of the Upload command. It contains the same fields:
1. filename : the file name.
2. file_sequence_number
3. feature_sequence_number.
See also:
Files - Upload a private file
POST /v1/files/search
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
Content-Type: application/json
X-Working-Project-Id: 64e0a6e970a5f601e6d3ad1c
{
"filename" : "Photo1.jpg",
"file_sequence_number" : "File_Sequence_Number",
"feature_sequence_number" : "3DA710B4-3E83-11EE-B700-BC9A78563412"
}
{
"file" : {
"fileSequenceNumber" : "File_Sequence_Number",
"id" : "64e0a6e970a5f601e6d3ad1d",
"filename" : "Photo1.jpg",
"download_url" : "/v1/files/64e0a6e970a5f601e6d3ad1d/Photo1.jpg",
"downloaded" : false,
"feature_sequence_number" : "3DA710B4-3E83-11EE-B700-BC9A78563412",
"user_id" : "64e0a6e970a5f601e6d3ad15",
"report_file" : false,
"report_status" : null
},
"uri" : "/v1/files/search",
"status" : 200
}
Download a private file. The GET request must contain the id and the filename returned in the response of the upload command.
See also:
Files - Upload a private file
GET /v1/files/64e0a6e970a5f601e6d3ad1d/Photo1.jpg
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
X-Working-Project-Id: 64e0a6e970a5f601e6d3ad1c
Delete the private file. The DELETE request must contain the id and the filename returned in the response of the upload command.
See also:
Files - Upload a private file
DELETE /v1/files/64e0a6e970a5f601e6d3ad1d/Photo1.jpg
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
X-Working-Project-Id: 64e0a6e970a5f601e6d3ad1c
{
"file" : {
"fileSequenceNumber" : null,
"id" : null,
"filename" : "Photo1.jpg",
"download_url" : null,
"downloaded" : false,
"feature_sequence_number" : "3DA710B4-3E83-11EE-B700-BC9A78563412",
"user_id" : "64e0a6e970a5f601e6d3ad15",
"report_file" : false,
"report_status" : null
},
"uri" : "/v1/files/64e0a6e970a5f601e6d3ad1d/Photo1.jpg",
"status" : 200
}
Upload a public file. A public file is accessible without authentication. The URL of the MyCumulus back-end combined with the download_url in the response, allows any user to download the file.
The Request Body contains the fields:
1. filename : the file name must be unique for the user (identified by its authentication). It's the responsibility of the client to make the name unique.
2. file_sequence_number : Is used to guaranty that the file is not stored twice on the server in case the upload command has to be repeated in case of a communcation error. The value may be null.
See also:
Files - Download a public file
Files - Delete a public file
POST /v1/files/public
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
Content-Type: application/json
{
"filename" : "Photo1.jpg",
"file_sequence_number" : "File_Sequence_Number",
"base64_encoded_content" : "Removed base64_encoded_content from report"
}
{
"file" : {
"fileSequenceNumber" : "File_Sequence_Number",
"id" : "64e0a6e970a5f601e6d3ad20",
"filename" : "Photo1.jpg",
"download_url" : "/v1/files/public/64e0a6e970a5f601e6d3ad20/Photo1.jpg",
"downloaded" : false,
"feature_sequence_number" : null,
"user_id" : "64e0a6e970a5f601e6d3ad15",
"report_file" : false,
"report_status" : null
},
"uri" : "/v1/files/public",
"status" : 200
}
Downloads a public file. The GET request must contain the id and the filename returned in the response of the upload command.
See also:
Files - Upload a public file
GET /v1/files/public/64e0a6e970a5f601e6d3ad20/Photo1.jpg
Check if a public file exists. This command is introduced to check if a file exists in case commnunication errors aborted uploading.
The Request Body is identical to the request body of the Upload command. It contains the same fields:
1. filename : the file name.
2. file_sequence_number
See also:
Files - Upload a public file
POST /v1/files/public/search
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
Content-Type: application/json
{
"filename" : "Photo1.jpg",
"file_sequence_number" : "File_Sequence_Number"
}
{
"file" : {
"fileSequenceNumber" : "File_Sequence_Number",
"id" : "64e0a6e970a5f601e6d3ad20",
"filename" : "Photo1.jpg",
"download_url" : "/v1/files/public/64e0a6e970a5f601e6d3ad20/Photo1.jpg",
"downloaded" : false,
"feature_sequence_number" : null,
"user_id" : "64e0a6e970a5f601e6d3ad15",
"report_file" : false,
"report_status" : null
},
"uri" : "/v1/files/public/search",
"status" : 200
}
Delete the public file. The DELETE request must contain the id and the filename returned in the response of the upload command.
See also:
Files - Upload a public file
DELETE /v1/files/public/64e0a6e970a5f601e6d3ad20/Photo1.jpg
X-Auth-Token: d0f2d2a1904ce844956f566c5956818388cd6197ccd5daa538d1a06754618da95f4753a064f7e070afc6af3971b65e2aa711512b9e95778edf8cfdf8d67b6385e1a7232b54da21d31f2f7dd48bf3582252b39b1ba603bc7baa6058e668f283a15eda746a1f78f878f8f628a693dd614c5f3e68d9251dc88733c3e5239f
{
"file" : {
"fileSequenceNumber" : "File_Sequence_Number",
"id" : "64e0a6e970a5f601e6d3ad20",
"filename" : "Photo1.jpg",
"download_url" : null,
"downloaded" : false,
"feature_sequence_number" : null,
"user_id" : "64e0a6e970a5f601e6d3ad15",
"report_file" : false,
"report_status" : null
},
"uri" : "/v1/files/public/64e0a6e970a5f601e6d3ad20/Photo1.jpg",
"status" : 200
}