{"_id":"5783990d5cbce30e0074e158","category":"5783990d5cbce30e0074e146","link_url":"","order":0,"__v":14,"hidden":false,"parentDoc":null,"slug":"welcome","user":"5492aa57f0d1810b0066005f","api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"createdAt":"2014-12-18T10:22:08.772Z","githubsync":"","project":"5783990d5cbce30e0074e144","updates":["596930651d1d1d0015ce5249"],"version":"5783990d5cbce30e0074e145","body":"Welcome to the Slemma API documentation!\n\nYou can view code examples in the area to the right. Currently we provide examples in Curl only. To make exploring the API as easy as possible, we have added an API explorer feature. Click 'Test in the API Explorer' button to send test requests.\n\nFor more information about Slemma you can visit our [product documentation](http://support.slemma.com/).\n\nAs an added service, Slemma provides the ability to embed dashboards and reports into existing web applications. **To add and authorize new users/clients to see embedded dashboards, you can use Slemma's API. You may also create the client accounts which are managed by a master Team using the API. If you want to enable any of these features for your account, please send an email at [help@slemma.com](mailto:help@slemma.com).**","excerpt":"","sync_unique":"","title":"Welcome","type":"basic","isReference":true,"link_external":false,"next":{"pages":[]},"childrenPages":[]}

Welcome


Welcome to the Slemma API documentation! You can view code examples in the area to the right. Currently we provide examples in Curl only. To make exploring the API as easy as possible, we have added an API explorer feature. Click 'Test in the API Explorer' button to send test requests. For more information about Slemma you can visit our [product documentation](http://support.slemma.com/). As an added service, Slemma provides the ability to embed dashboards and reports into existing web applications. **To add and authorize new users/clients to see embedded dashboards, you can use Slemma's API. You may also create the client accounts which are managed by a master Team using the API. If you want to enable any of these features for your account, please send an email at [help@slemma.com](mailto:help@slemma.com).**
Welcome to the Slemma API documentation! You can view code examples in the area to the right. Currently we provide examples in Curl only. To make exploring the API as easy as possible, we have added an API explorer feature. Click 'Test in the API Explorer' button to send test requests. For more information about Slemma you can visit our [product documentation](http://support.slemma.com/). As an added service, Slemma provides the ability to embed dashboards and reports into existing web applications. **To add and authorize new users/clients to see embedded dashboards, you can use Slemma's API. You may also create the client accounts which are managed by a master Team using the API. If you want to enable any of these features for your account, please send an email at [help@slemma.com](mailto:help@slemma.com).**
{"_id":"5783990d5cbce30e0074e155","__v":26,"order":1,"slug":"api-summary","type":"basic","updates":["59529557a6c9140033c80819"],"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","category":"5783990d5cbce30e0074e146","excerpt":"","next":{"description":"","pages":[]},"parentDoc":null,"project":"5783990d5cbce30e0074e144","sync_unique":"","title":"API summary","link_url":"","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"All currently available resources are listed in this documentation. If you have any suggestions for anything more you'd like to see in our API, please contact [help@slemma.com](mailto:help@slemma.com) - we will probably build them!\n\n## Endpoint path\nSlemma API is hosted at https://slemma.com/api/v1. \n\n## HTTP Request Methods\nThe Slemma API uses the following request methods when accessing API resources: GET, POST, PUT and DELETE.\nThe **GET** method is used to retrieve (or read) a representation of a resource users, groups, and teams.\nThe **POST** method is used to update an existing resource.\nThe **PUT** method is used to create new resources.\nThe **DELETE** method is used to delete an existing resource.\n\n\n##Making API Requests \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You have to be a team Admin or Owner to be able to make requests. Calls made by non-Admin users will fail (you'll get 403 Forbidden).\",\n  \"title\": \"Note\"\n}\n[/block]\nAll API requests must be sent over HTTPS. Each request to Slemma's API endpoints must include the following HTTP headers:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"TeamID\",\n    \"1-0\": \"SIG\",\n    \"2-0\": \"Content-Type\",\n    \"h-0\": \"Header Name\",\n    \"0-1\": \"Team ID\",\n    \"1-1\": \"Calculated as sha1(<Team Secret> + <User Token>)\",\n    \"2-1\": \"\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"1-2\": \"a214bb15a05b1cde9a1e31d19d0660b18fb37394\",\n    \"2-2\": \"application/json;charset=UTF-8\",\n    \"0-2\": \"131219\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## How to get your Team ID, Team Secret, User Token and SIG\n\nYour Team ID, Team Secret and User Token are available on the API Keys page on Slemma, accessible from your Admin menu option. You will also see the generated SIG parameter. You can recreate Team Secret by clicking 'Generate new Team Secret' button. Your new Team Secret and new SIG parameter will then appear on the page.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b5a2813-2016-09-02_13-32-03.jpg\",\n        \"2016-09-02_13-32-03.jpg\",\n        943,\n        518,\n        \"#f0eff0\"\n      ],\n      \"sizing\": \"full\",\n      \"border\": false\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"User Token must be kept secret and transferred only over SSL, as it's effectively as good as a user's email and password.\",\n  \"title\": \"Warning\"\n}\n[/block]\n## Response Formats\n\nCurrently the only available response format is JSON and responses are type 'application/json'.\n\n## Response Codes\n\nThe following error messages descriptions are valid for any request and any object\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"401 Unauthorized\",\n    \"1-0\": \"401 Unauthorized\",\n    \"0-1\": \"Incorrect teamid\",\n    \"1-1\": \"Incorrect sig\",\n    \"1-2\": \"Wrong SIG: please check your request and put in correct SIG parameter\",\n    \"0-2\": \"Wrong teamid: please check your request and put in correct teamid parameter\",\n    \"2-0\": \"404 Not Found\",\n    \"3-0\": \"404 Not Found\",\n    \"4-0\": \"405 Method Not Allowed\",\n    \"4-1\": \"No content\",\n    \"3-1\": \"No content\",\n    \"2-1\": \"End point not found\",\n    \"2-2\": \"The requested endpoint was not found.\",\n    \"3-2\": \"The requested URL was not found on this server.\",\n    \"4-2\": \"This request method cannot be used: check the documentation for allowed methods.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n## Date Formats\n\nAll dates values are returned in UTC. \n\n##Rate Limits\nRecords per request\n\nSlemma support up to 10000 records per request for append data to a Custom Dataset.\n\n\nIf you ever have any questions, or see anywhere we can improve our documentation, feel free to contact us by emailing [help@slemma.com](mailto:help@slemma.com) or use the 'Suggest edits' option which can be fount on each page.","createdAt":"2014-12-18T14:09:38.982Z","githubsync":"","hidden":false,"isReference":true,"link_external":false,"childrenPages":[]}

API summary


All currently available resources are listed in this documentation. If you have any suggestions for anything more you'd like to see in our API, please contact [help@slemma.com](mailto:help@slemma.com) - we will probably build them! ## Endpoint path Slemma API is hosted at https://slemma.com/api/v1. ## HTTP Request Methods The Slemma API uses the following request methods when accessing API resources: GET, POST, PUT and DELETE. The **GET** method is used to retrieve (or read) a representation of a resource users, groups, and teams. The **POST** method is used to update an existing resource. The **PUT** method is used to create new resources. The **DELETE** method is used to delete an existing resource. ##Making API Requests [block:callout] { "type": "info", "body": "You have to be a team Admin or Owner to be able to make requests. Calls made by non-Admin users will fail (you'll get 403 Forbidden).", "title": "Note" } [/block] All API requests must be sent over HTTPS. Each request to Slemma's API endpoints must include the following HTTP headers: [block:parameters] { "data": { "0-0": "TeamID", "1-0": "SIG", "2-0": "Content-Type", "h-0": "Header Name", "0-1": "Team ID", "1-1": "Calculated as sha1(<Team Secret> + <User Token>)", "2-1": "", "h-1": "Description", "h-2": "Example", "1-2": "a214bb15a05b1cde9a1e31d19d0660b18fb37394", "2-2": "application/json;charset=UTF-8", "0-2": "131219" }, "cols": 3, "rows": 3 } [/block] ## How to get your Team ID, Team Secret, User Token and SIG Your Team ID, Team Secret and User Token are available on the API Keys page on Slemma, accessible from your Admin menu option. You will also see the generated SIG parameter. You can recreate Team Secret by clicking 'Generate new Team Secret' button. Your new Team Secret and new SIG parameter will then appear on the page. [block:image] { "images": [ { "image": [ "https://files.readme.io/b5a2813-2016-09-02_13-32-03.jpg", "2016-09-02_13-32-03.jpg", 943, 518, "#f0eff0" ], "sizing": "full", "border": false } ] } [/block] [block:callout] { "type": "danger", "body": "User Token must be kept secret and transferred only over SSL, as it's effectively as good as a user's email and password.", "title": "Warning" } [/block] ## Response Formats Currently the only available response format is JSON and responses are type 'application/json'. ## Response Codes The following error messages descriptions are valid for any request and any object [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "401 Unauthorized", "1-0": "401 Unauthorized", "0-1": "Incorrect teamid", "1-1": "Incorrect sig", "1-2": "Wrong SIG: please check your request and put in correct SIG parameter", "0-2": "Wrong teamid: please check your request and put in correct teamid parameter", "2-0": "404 Not Found", "3-0": "404 Not Found", "4-0": "405 Method Not Allowed", "4-1": "No content", "3-1": "No content", "2-1": "End point not found", "2-2": "The requested endpoint was not found.", "3-2": "The requested URL was not found on this server.", "4-2": "This request method cannot be used: check the documentation for allowed methods." }, "cols": 3, "rows": 5 } [/block] ## Date Formats All dates values are returned in UTC. ##Rate Limits Records per request Slemma support up to 10000 records per request for append data to a Custom Dataset. If you ever have any questions, or see anywhere we can improve our documentation, feel free to contact us by emailing [help@slemma.com](mailto:help@slemma.com) or use the 'Suggest edits' option which can be fount on each page.
All currently available resources are listed in this documentation. If you have any suggestions for anything more you'd like to see in our API, please contact [help@slemma.com](mailto:help@slemma.com) - we will probably build them! ## Endpoint path Slemma API is hosted at https://slemma.com/api/v1. ## HTTP Request Methods The Slemma API uses the following request methods when accessing API resources: GET, POST, PUT and DELETE. The **GET** method is used to retrieve (or read) a representation of a resource users, groups, and teams. The **POST** method is used to update an existing resource. The **PUT** method is used to create new resources. The **DELETE** method is used to delete an existing resource. ##Making API Requests [block:callout] { "type": "info", "body": "You have to be a team Admin or Owner to be able to make requests. Calls made by non-Admin users will fail (you'll get 403 Forbidden).", "title": "Note" } [/block] All API requests must be sent over HTTPS. Each request to Slemma's API endpoints must include the following HTTP headers: [block:parameters] { "data": { "0-0": "TeamID", "1-0": "SIG", "2-0": "Content-Type", "h-0": "Header Name", "0-1": "Team ID", "1-1": "Calculated as sha1(<Team Secret> + <User Token>)", "2-1": "", "h-1": "Description", "h-2": "Example", "1-2": "a214bb15a05b1cde9a1e31d19d0660b18fb37394", "2-2": "application/json;charset=UTF-8", "0-2": "131219" }, "cols": 3, "rows": 3 } [/block] ## How to get your Team ID, Team Secret, User Token and SIG Your Team ID, Team Secret and User Token are available on the API Keys page on Slemma, accessible from your Admin menu option. You will also see the generated SIG parameter. You can recreate Team Secret by clicking 'Generate new Team Secret' button. Your new Team Secret and new SIG parameter will then appear on the page. [block:image] { "images": [ { "image": [ "https://files.readme.io/b5a2813-2016-09-02_13-32-03.jpg", "2016-09-02_13-32-03.jpg", 943, 518, "#f0eff0" ], "sizing": "full", "border": false } ] } [/block] [block:callout] { "type": "danger", "body": "User Token must be kept secret and transferred only over SSL, as it's effectively as good as a user's email and password.", "title": "Warning" } [/block] ## Response Formats Currently the only available response format is JSON and responses are type 'application/json'. ## Response Codes The following error messages descriptions are valid for any request and any object [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "401 Unauthorized", "1-0": "401 Unauthorized", "0-1": "Incorrect teamid", "1-1": "Incorrect sig", "1-2": "Wrong SIG: please check your request and put in correct SIG parameter", "0-2": "Wrong teamid: please check your request and put in correct teamid parameter", "2-0": "404 Not Found", "3-0": "404 Not Found", "4-0": "405 Method Not Allowed", "4-1": "No content", "3-1": "No content", "2-1": "End point not found", "2-2": "The requested endpoint was not found.", "3-2": "The requested URL was not found on this server.", "4-2": "This request method cannot be used: check the documentation for allowed methods." }, "cols": 3, "rows": 5 } [/block] ## Date Formats All dates values are returned in UTC. ##Rate Limits Records per request Slemma support up to 10000 records per request for append data to a Custom Dataset. If you ever have any questions, or see anywhere we can improve our documentation, feel free to contact us by emailing [help@slemma.com](mailto:help@slemma.com) or use the 'Suggest edits' option which can be fount on each page.
{"_id":"583c276d309cec1900f3dbf1","link_url":"","order":0,"sync_unique":"","title":"Ping","updates":[],"__v":0,"body":"Returns 'OK' if the call succeeded. Otherwise, check your SIG and TeamID values.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"Connection success\",\n    \"0-2\": \"Everything worked correctly.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","isReference":true,"hidden":false,"parentDoc":null,"type":"get","api":{"examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/ping"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"text","code":" Connection success","name":""},{"code":"Depending on the errors:\n1. Incorrect teamid\n2. Incorrect sig","language":"text","status":401}]},"settings":"","url":"/ping","auth":"required"},"createdAt":"2016-11-28T12:47:41.334Z","githubsync":"","project":"5783990d5cbce30e0074e144","user":"5492aa57f0d1810b0066005f","category":"5783990d5cbce30e0074e14a","next":{"pages":[],"description":""},"version":"5783990d5cbce30e0074e145","excerpt":"The method allows to check if you are using correct SIG and TeamID values for your calls. We recommend to use it before you make any other calls.","link_external":false,"slug":"ping","childrenPages":[]}

getPing

The method allows to check if you are using correct SIG and TeamID values for your calls. We recommend to use it before you make any other calls.

Returns 'OK' if the call succeeded. Otherwise, check your SIG and TeamID values. [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "Connection success", "0-2": "Everything worked correctly." }, "cols": 3, "rows": 1 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns 'OK' if the call succeeded. Otherwise, check your SIG and TeamID values. [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "Connection success", "0-2": "Everything worked correctly." }, "cols": 3, "rows": 1 } [/block]
{"_id":"578499a4b3a5402400fee931","__v":9,"body":"##Returns\nReturns a new user token for this user.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"User Token must be kept secret and transferred only over SSL, as it's effectively as good as a user's email and password.\",\n  \"title\": \"Warning\"\n}\n[/block]\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"Everything worked correctly. A token has been retrieved.\",\n    \"1-0\": \"404 Not Found\",\n    \"1-1\": \"Object not found\",\n    \"1-2\": \"An user not found.\",\n    \"0-1\": \"e111f69d-9dd0-89c7-a8b3-86200f9421f3\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","category":"5783990d5cbce30e0074e14a","editedParams":true,"editedParams2":true,"link_external":false,"githubsync":"","isReference":true,"link_url":"","order":1,"slug":"get-access-token","updates":[],"parentDoc":null,"project":"5783990d5cbce30e0074e144","sync_unique":"","title":"Getting an access token","type":"get","api":{"results":{"codes":[{"name":"","code":"e111f69d-9dd0-89c7-a8b3-86200f9421f3","language":"text","status":200},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","url":"/tokens/:UserKey","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/tokens/9\n"}]},"method":"get","params":[{"in":"path","name":"UserKey","ref":"","required":true,"type":"int","_id":"5784b9425ae9c20e00bc24b3","default":"","desc":"The identifier of the user for which you need to get the access token."}]},"createdAt":"2016-07-12T07:17:56.060Z","excerpt":"Generates user tokens for individual users.","hidden":false,"next":{"description":"","pages":[]},"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","childrenPages":[]}

getGetting an access token

Generates user tokens for individual users.

Path Params

UserKey:
required
integer
The identifier of the user for which you need to get the access token.
##Returns Returns a new user token for this user. [block:callout] { "type": "danger", "body": "User Token must be kept secret and transferred only over SSL, as it's effectively as good as a user's email and password.", "title": "Warning" } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "Everything worked correctly. A token has been retrieved.", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "An user not found.", "0-1": "e111f69d-9dd0-89c7-a8b3-86200f9421f3" }, "cols": 3, "rows": 2 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



##Returns Returns a new user token for this user. [block:callout] { "type": "danger", "body": "User Token must be kept secret and transferred only over SSL, as it's effectively as good as a user's email and password.", "title": "Warning" } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "Everything worked correctly. A token has been retrieved.", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "An user not found.", "0-1": "e111f69d-9dd0-89c7-a8b3-86200f9421f3" }, "cols": 3, "rows": 2 } [/block]
{"_id":"578666ebe5cdf20e007d37e8","link_url":"","type":"basic","category":"5783990d5cbce30e0074e150","createdAt":"2016-07-13T16:06:03.129Z","githubsync":"","title":"Users","body":"The Users resource is one of the primarily ways of interacting with Slemma. Someone using Slemma can either be a 'User' or 'Client'. You can retrieve, create, update and delete a user, as well as list all users. Users are identified by an unique ID. \n**To be able to manage 'Clients' you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**","isReference":true,"parentDoc":null,"order":0,"sync_unique":"","__v":4,"hidden":false,"project":"5783990d5cbce30e0074e144","slug":"users","updates":["595297e4d93ebe003ff33a66"],"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"excerpt":"","link_external":false,"next":{"pages":[]},"childrenPages":[]}

Users


The Users resource is one of the primarily ways of interacting with Slemma. Someone using Slemma can either be a 'User' or 'Client'. You can retrieve, create, update and delete a user, as well as list all users. Users are identified by an unique ID. **To be able to manage 'Clients' you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**
The Users resource is one of the primarily ways of interacting with Slemma. Someone using Slemma can either be a 'User' or 'Client'. You can retrieve, create, update and delete a user, as well as list all users. Users are identified by an unique ID. **To be able to manage 'Clients' you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**
{"_id":"58c0e70c84a3590f00c0ceae","updates":[],"__v":0,"body":"** A User Object contains the following fields:** \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Key\",\n    \"6-0\": \"Email\",\n    \"5-0\": \"LastName\",\n    \"7-0\": \"GroupKey\",\n    \"4-0\": \"FirstName\",\n    \"2-0\": \"[Role](doc:teamrole)\",\n    \"0-1\": \"Integer\",\n    \"2-1\": \"Enum\",\n    \"4-1\": \"String\",\n    \"5-1\": \"String\",\n    \"6-1\": \"String\",\n    \"7-1\": \"Integer\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The Slemma defined id representing the user\",\n    \"2-2\": \"The role of the user. Users of type 'User' may have either 'User' or 'Admin' role, but users of type 'Client' may only have 'User' role.\",\n    \"4-2\": \"User first name\",\n    \"5-2\": \"User last name\",\n    \"6-2\": \"Email address of the user\",\n    \"7-2\": \"The Slemma defined id representing the group the user belongs to.\",\n    \"8-0\": \"CreatedAt\",\n    \"8-1\": \"TimeStamp\",\n    \"8-2\": \"The time the user was created\",\n    \"9-0\": \"[AuthType](doc:authtype)\",\n    \"9-1\": \"String\",\n    \"9-2\": \"The authorization type of a user. The attribute defines how the user is authorized in Slemma; The user may sign in using the email address or one of the social buttons. Possible values are listed [here](doc:authtype).\",\n    \"3-0\": \"CanCreate\",\n    \"3-2\": \"List of [object types](doc:objectype) the user is allowed to create.\\nField is not provided for users of type 'Client' or for users with 'Admin' role.\",\n    \"1-2\": \"The type of the user. The attribute defines weather the user is an external user or the internal one. Possible values are listed [here](doc:teammembertype).\",\n    \"1-1\": \"Enum\",\n    \"1-0\": \"[Type](doc:teammembertype)\",\n    \"3-1\": \"Array of Objects\",\n    \"10-0\": \"TeamAttributes\",\n    \"10-1\": \"Array of Objects\",\n    \"11-0\": \"*Key*\",\n    \"13-0\": \"*Value* \",\n    \"11-1\": \"Integer\",\n    \"13-1\": \"String\",\n    \"10-2\": \"An array containing Team Attributes each with specified values on the field.\",\n    \"11-2\": \"A unique identifier for the team attribute.\",\n    \"13-2\": \"A value for the team attribute.\",\n    \"12-0\": \"*Name*\",\n    \"12-1\": \"String\",\n    \"12-2\": \"The name of the attribute.\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\n}\n[/block]","category":"5783990d5cbce30e0074e150","createdAt":"2017-03-09T05:24:28.509Z","githubsync":"","hidden":false,"project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]}},"link_url":"","order":1,"parentDoc":null,"slug":"the-user-object-old","type":"basic","link_external":false,"next":{"description":"","pages":[]},"title":"The User Object","excerpt":"","isReference":true,"sync_unique":"","user":"5492aa57f0d1810b0066005f","childrenPages":[]}

The User Object


** A User Object contains the following fields:** [block:parameters] { "data": { "0-0": "Key", "6-0": "Email", "5-0": "LastName", "7-0": "GroupKey", "4-0": "FirstName", "2-0": "[Role](doc:teamrole)", "0-1": "Integer", "2-1": "Enum", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the user", "2-2": "The role of the user. Users of type 'User' may have either 'User' or 'Admin' role, but users of type 'Client' may only have 'User' role.", "4-2": "User first name", "5-2": "User last name", "6-2": "Email address of the user", "7-2": "The Slemma defined id representing the group the user belongs to.", "8-0": "CreatedAt", "8-1": "TimeStamp", "8-2": "The time the user was created", "9-0": "[AuthType](doc:authtype)", "9-1": "String", "9-2": "The authorization type of a user. The attribute defines how the user is authorized in Slemma; The user may sign in using the email address or one of the social buttons. Possible values are listed [here](doc:authtype).", "3-0": "CanCreate", "3-2": "List of [object types](doc:objectype) the user is allowed to create.\nField is not provided for users of type 'Client' or for users with 'Admin' role.", "1-2": "The type of the user. The attribute defines weather the user is an external user or the internal one. Possible values are listed [here](doc:teammembertype).", "1-1": "Enum", "1-0": "[Type](doc:teammembertype)", "3-1": "Array of Objects", "10-0": "TeamAttributes", "10-1": "Array of Objects", "11-0": "*Key*", "13-0": "*Value* ", "11-1": "Integer", "13-1": "String", "10-2": "An array containing Team Attributes each with specified values on the field.", "11-2": "A unique identifier for the team attribute.", "13-2": "A value for the team attribute.", "12-0": "*Name*", "12-1": "String", "12-2": "The name of the attribute." }, "cols": 3, "rows": 14 } [/block]
** A User Object contains the following fields:** [block:parameters] { "data": { "0-0": "Key", "6-0": "Email", "5-0": "LastName", "7-0": "GroupKey", "4-0": "FirstName", "2-0": "[Role](doc:teamrole)", "0-1": "Integer", "2-1": "Enum", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the user", "2-2": "The role of the user. Users of type 'User' may have either 'User' or 'Admin' role, but users of type 'Client' may only have 'User' role.", "4-2": "User first name", "5-2": "User last name", "6-2": "Email address of the user", "7-2": "The Slemma defined id representing the group the user belongs to.", "8-0": "CreatedAt", "8-1": "TimeStamp", "8-2": "The time the user was created", "9-0": "[AuthType](doc:authtype)", "9-1": "String", "9-2": "The authorization type of a user. The attribute defines how the user is authorized in Slemma; The user may sign in using the email address or one of the social buttons. Possible values are listed [here](doc:authtype).", "3-0": "CanCreate", "3-2": "List of [object types](doc:objectype) the user is allowed to create.\nField is not provided for users of type 'Client' or for users with 'Admin' role.", "1-2": "The type of the user. The attribute defines weather the user is an external user or the internal one. Possible values are listed [here](doc:teammembertype).", "1-1": "Enum", "1-0": "[Type](doc:teammembertype)", "3-1": "Array of Objects", "10-0": "TeamAttributes", "10-1": "Array of Objects", "11-0": "*Key*", "13-0": "*Value* ", "11-1": "Integer", "13-1": "String", "10-2": "An array containing Team Attributes each with specified values on the field.", "11-2": "A unique identifier for the team attribute.", "13-2": "A value for the team attribute.", "12-0": "*Name*", "12-1": "String", "12-2": "The name of the attribute." }, "cols": 3, "rows": 14 } [/block]
{"_id":"5909cc0295b5490f0052f014","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","excerpt":"Creates a new user object.","link_url":"","parentDoc":null,"slug":"create-a-new-user","sync_unique":"","body":"## Parameter URL \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"0-0\": \"send_email\",\n    \"h-1\": \"Type\",\n    \"0-1\": \"Boolean\",\n    \"h-2\": \"Required\",\n    \"h-3\": \"Default value\",\n    \"0-2\": \"No\",\n    \"h-4\": \"Description\",\n    \"0-3\": \"false\",\n    \"0-4\": \"If send_email is true, an email invitation will be sent to the user.\"\n  },\n  \"cols\": 5,\n  \"rows\": 1\n}\n[/block]\n## Returns\n\nReturns a new user object if the call succeeded. If a Slemma account exists with the email address specified in the call, this call will simply add this user to a new team with the new Groupkey, Role and Type. The user can belong to any number of teams, but can be the owner of one team only.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response сontent\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"4-0\": \"400 Bad Request\",\n    \"5-0\": \"400 Bad Request\",\n    \"6-0\": \"400 Bad Request\",\n    \"1-1\": \"Email cannot be empty\",\n    \"2-1\": \"Invalid email address\",\n    \"3-1\": \"Invalid User Type:\\\"IncorrectType\\\"\",\n    \"4-1\": \"Invalid user role:\\\"IncorrectRole\\\"\",\n    \"5-1\": \"'Clients' feature is inactive.\",\n    \"6-1\": \"CanCreate is not available for admins\",\n    \"7-1\": \"Incorrect user Type\",\n    \"7-0\": \"400 Bad Request\",\n    \"8-0\": \"400 Bad Request\",\n    \"8-2\": \"A team attribute wasn't found.\",\n    \"8-1\": \"Attribute not found, Key=112\",\n    \"0-2\": \"The user has been created successfully.\",\n    \"1-2\": \"The field \\\"Email\\\" cannot be empty.\",\n    \"3-2\": \"The 'Type' parameter that was specified is invalid.\",\n    \"4-2\": \"The 'Role' parameter that was specified is invalid.\",\n    \"2-2\": \"The email address that was specified is invalid.\",\n    \"0-1\": \"The user object\",\n    \"7-2\": \"The 'Type' parameter that was specified doesn't match the corresponding group [UserType](doc:teammembertype) .\",\n    \"5-2\": \"You need the 'Clients' feature to be enabled for your account to create a new client.\",\n    \"6-2\": \"'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]","isReference":true,"next":{"pages":[],"description":""},"project":"5783990d5cbce30e0074e144","type":"put","updates":[],"category":"5783990d5cbce30e0074e150","createdAt":"2017-05-03T12:24:34.420Z","githubsync":"","hidden":false,"__v":0,"api":{"examples":{"codes":[{"language":"curl","code":"cURL -i -X PUT\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d  {\"FirstName\":\"Jack\", \n   \t\t\t\"LastName\": \"Smith\", \n        \"Email\": \"example@example.com\", \n        \"Role\" : \"User\", \n        \"Type\" : \"User\", \n        \"GroupKey\":76, \n        \"CanCreate\": {\n        \t\"Dashboards\": false,\n        \t\"DataSet\": true,\n        \t\"Delivery\": false,\n        \t\"Integrations\": true,\n        \t\"Reports\": false,\n        \t\"Sharing\": false},\n        \"TeamAttributes\": [{\n        \t\"Key\": 2,\n        \t\"Value\": \"15260 Ventura Blvd, Suite 2230\"},\n          {\"Key\": 3,\n        \t\"Value\": \"+1 (805) 111-1111\"}]\n        }\nhttps://slemma.com/api/v1/users?send_email=true"}]},"method":"put","params":[{"in":"body","required":true,"desc":"User's email address.","default":"","type":"string","name":"Email","_id":"55767c611ce9e637005014e1","ref":""},{"name":"Role","ref":"","required":true,"type":"string","_id":"55767c611ce9e637005014e0","default":"User","desc":"User role. The identifier of the role to give the user. 'Clients' can be a 'User' or a 'GroupAdmin' only. You can't create a team 'Owner'.","in":"body"},{"name":"Type","_id":"5784a2f0b3a5402400fee946","ref":"","in":"body","required":true,"desc":"User type. The identifier of the type to assign to the user.","default":"User","type":"string"},{"type":"string","name":"FirstName","_id":"55767c611ce9e637005014df","ref":"","in":"body","required":false,"desc":"First name of the user","default":""},{"desc":"Last name of the user","default":"","type":"string","name":"LastName","_id":"55767c611ce9e637005014de","ref":"","in":"body","required":false},{"_id":"55767c611ce9e637005014dd","ref":"","in":"body","required":false,"desc":"The ID of an existing group to add this user to. The default value '0' adds the user without assigning them to any group.","default":"0","type":"int","name":"GroupKey"},{"name":"send_email","_id":"578cc29408b47a0e000a4d37","ref":"","in":"query","required":false,"desc":"Optional boolean to send a welcome email to the user. If send_email is false, no email invitation will be sent to the user. This may be useful for white labeled apps that want to handle Slemma announcements themselves.","default":"false","type":"boolean"},{"type":"object","name":"CanCreate","_id":"584a50ca807eb00f0049188b","ref":"","in":"body","required":false,"desc":"List of object types the user can create in the Team. If this parameter is not explicitly set, all object types are allowed. If this parameter exists, all omitted object types default to false (denied).","default":""},{"desc":"List of team attributes with values. All values must be a string type.","default":"","type":"object","name":"TeamAttributes","_id":"58c2332616c5b70f0083b0fb","ref":"","in":"body","required":false}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"Key\": 14388,\n  \"Email\": \"example@example.com\",\n  \"FirstName\": \"Jack\",\n  \"LastName\": \"Smith\",\n  \"AuthType\": \"Slemma Login\",\n  \"Type\": \"User\",\n  \"Role\": \"User\",\n  \"GroupKey\": 0,\n  \"CreatedAt\": \"2017-03-20 15:54:53.968+0500\",\n  \"CanCreate\": {\n    \"DataSet\": true,\n    \"Delivery\": false,\n    \"Sharing\": false,\n    \"Reports\": false,\n    \"Dashboards\": false,\n    \"Presentations\": false,\n    \"Integrations\": true},\n\t\"TeamAttributes\": [\n    {\n      \"Key\": 3,\n      \"Name\": \"Phone\",\n      \"Value\": \"+1 (805) 111-1111\"\n    },\n    {\n      \"Key\": 2,\n      \"Name\": \"Address\",\n      \"Value\": \"15260 Ventura Blvd, Suite 2230\"\n    }],\n}","name":""},{"language":"text","code":"Depending on the errors:\n1. Email cannot be empty\n2. Invalid email address\n3. Invalid user type:\"IncorrectType\"\n4. Invalid user role:\"IncorrectRole\"\n5. Clients is not available\n6. CanCreate is not available for admins\n7. Incorrect user Type\n8. Attribute not found, Key=112","name":"","status":400}]},"settings":"","url":"/users","auth":"required"},"link_external":false,"order":2,"title":"Create a New User","childrenPages":[]}

putCreate a New User

Creates a new user object.

Query Params

send_email:
booleanfalse
Optional boolean to send a welcome email to the user. If send_email is false, no email invitation will be sent to the user. This may be useful for white labeled apps that want to handle Slemma announcements themselves.

Body Params

Email:
required
string
User's email address.
Role:
required
stringUser
User role. The identifier of the role to give the user. 'Clients' can be a 'User' or a 'GroupAdmin' only. You can't create a team 'Owner'.
Type:
required
stringUser
User type. The identifier of the type to assign to the user.
FirstName:
string
First name of the user
LastName:
string
Last name of the user
GroupKey:
integer0
The ID of an existing group to add this user to. The default value '0' adds the user without assigning them to any group.
CanCreate:
object
List of object types the user can create in the Team. If this parameter is not explicitly set, all object types are allowed. If this parameter exists, all omitted object types default to false (denied).
TeamAttributes:
object
List of team attributes with values. All values must be a string type.
## Parameter URL [block:parameters] { "data": { "h-0": "Parameter", "0-0": "send_email", "h-1": "Type", "0-1": "Boolean", "h-2": "Required", "h-3": "Default value", "0-2": "No", "h-4": "Description", "0-3": "false", "0-4": "If send_email is true, an email invitation will be sent to the user." }, "cols": 5, "rows": 1 } [/block] ## Returns Returns a new user object if the call succeeded. If a Slemma account exists with the email address specified in the call, this call will simply add this user to a new team with the new Groupkey, Role and Type. The user can belong to any number of teams, but can be the owner of one team only. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response сontent", "h-2": "Description", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "400 Bad Request", "1-1": "Email cannot be empty", "2-1": "Invalid email address", "3-1": "Invalid User Type:\"IncorrectType\"", "4-1": "Invalid user role:\"IncorrectRole\"", "5-1": "'Clients' feature is inactive.", "6-1": "CanCreate is not available for admins", "7-1": "Incorrect user Type", "7-0": "400 Bad Request", "8-0": "400 Bad Request", "8-2": "A team attribute wasn't found.", "8-1": "Attribute not found, Key=112", "0-2": "The user has been created successfully.", "1-2": "The field \"Email\" cannot be empty.", "3-2": "The 'Type' parameter that was specified is invalid.", "4-2": "The 'Role' parameter that was specified is invalid.", "2-2": "The email address that was specified is invalid.", "0-1": "The user object", "7-2": "The 'Type' parameter that was specified doesn't match the corresponding group [UserType](doc:teammembertype) .", "5-2": "You need the 'Clients' feature to be enabled for your account to create a new client.", "6-2": "'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default." }, "cols": 3, "rows": 9 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Parameter URL [block:parameters] { "data": { "h-0": "Parameter", "0-0": "send_email", "h-1": "Type", "0-1": "Boolean", "h-2": "Required", "h-3": "Default value", "0-2": "No", "h-4": "Description", "0-3": "false", "0-4": "If send_email is true, an email invitation will be sent to the user." }, "cols": 5, "rows": 1 } [/block] ## Returns Returns a new user object if the call succeeded. If a Slemma account exists with the email address specified in the call, this call will simply add this user to a new team with the new Groupkey, Role and Type. The user can belong to any number of teams, but can be the owner of one team only. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response сontent", "h-2": "Description", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "400 Bad Request", "1-1": "Email cannot be empty", "2-1": "Invalid email address", "3-1": "Invalid User Type:\"IncorrectType\"", "4-1": "Invalid user role:\"IncorrectRole\"", "5-1": "'Clients' feature is inactive.", "6-1": "CanCreate is not available for admins", "7-1": "Incorrect user Type", "7-0": "400 Bad Request", "8-0": "400 Bad Request", "8-2": "A team attribute wasn't found.", "8-1": "Attribute not found, Key=112", "0-2": "The user has been created successfully.", "1-2": "The field \"Email\" cannot be empty.", "3-2": "The 'Type' parameter that was specified is invalid.", "4-2": "The 'Role' parameter that was specified is invalid.", "2-2": "The email address that was specified is invalid.", "0-1": "The user object", "7-2": "The 'Type' parameter that was specified doesn't match the corresponding group [UserType](doc:teammembertype) .", "5-2": "You need the 'Clients' feature to be enabled for your account to create a new client.", "6-2": "'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default." }, "cols": 3, "rows": 9 } [/block]
{"_id":"58c2351f33d7900f00c1a5cc","sync_unique":"","updates":["5952996c76da4b002929487b"],"body":"## Returns \nReturns an user object if a valid identifier was provided.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response сodes\",\n    \"h-1\": \"Response сontent\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"A user object\",\n    \"0-2\": \"A user has been retrieved successfully.\",\n    \"1-0\": \"404 Not Found\",\n    \"1-1\": \"Object not found\",\n    \"1-2\": \"A user with the specified key was not found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","createdAt":"2017-03-10T05:09:51.514Z","link_external":false,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/users/9\n"}]},"method":"get","params":[{"name":"key","_id":"5784b38c5ae9c20e00bc24a5","ref":"","in":"path","required":true,"desc":"The identifier of the user to be retrieved.","default":"","type":"int"}],"results":{"codes":[{"status":200,"name":"","code":"{\n  \"Key\": 9,\n  \"Email\": \"capsideas@gmail.com\",\n  \"FirstName\": \"Slemma\",\n  \"LastName\": \"Admin\",\n  \"AuthType\": \"Slemma Login\",\n  \"Type\": \"User\",\n  \"Role\": \"Owner\",\n  \"GroupKey\": 28,\n  \"CreatedAt\": \"2014-09-10 08:01:29.707+0600\",\n  \"CanCreate\": {\n        \"DataSet\": true,\n        \"Delivery\": false,\n        \"Sharing\": false,\n        \"Reports\": false,\n        \"Dashboards\": false,\n        \"Presentations\": false,\n        \"Integrations\": true\n    },\n  \"TeamAttributes\": [\n    {\n      \"Key\": 3,\n      \"Name\": \"Phone\",\n      \"Value\": \"+1 (805) 111-1111\"\n    },\n    {\n      \"Key\": 2,\n      \"Name\": \"Address\",\n      \"Value\": \"15260 Ventura Blvd, Suite 2230\"\n    }]\n}\n","language":"json"},{"language":"text","status":404,"code":"Object not found"}]},"settings":"","url":"/users/:key"},"link_url":"","version":"5783990d5cbce30e0074e145","githubsync":"","next":{"pages":[],"description":""},"slug":"retrieve-user","type":"get","user":"5492aa57f0d1810b0066005f","__v":1,"category":"5783990d5cbce30e0074e150","excerpt":"Retrieves the details of an existing user. Supply the unique user key (ID) and Slemma will return the corresponding user information.","order":3,"parentDoc":null,"project":"5783990d5cbce30e0074e144","title":"Retrieve a User","hidden":false,"isReference":true,"childrenPages":[]}

getRetrieve a User

Retrieves the details of an existing user. Supply the unique user key (ID) and Slemma will return the corresponding user information.

Path Params

key:
required
integer
The identifier of the user to be retrieved.
## Returns Returns an user object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response сodes", "h-1": "Response сontent", "h-2": "Description", "0-0": "200 OK", "0-1": "A user object", "0-2": "A user has been retrieved successfully.", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "A user with the specified key was not found." }, "cols": 3, "rows": 2 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns an user object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response сodes", "h-1": "Response сontent", "h-2": "Description", "0-0": "200 OK", "0-1": "A user object", "0-2": "A user has been retrieved successfully.", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "A user with the specified key was not found." }, "cols": 3, "rows": 2 } [/block]
{"_id":"58c235864922930f0050aba7","updates":["59529a0ea6c9140033c8082e"],"user":"5492aa57f0d1810b0066005f","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"* To update 'TeamAttributes', you must provide en **entire** list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.\\n* To delete all attributes, pass TeamAttributes parameter with an empty array/hash.\\n<code> \\n{\\n  \\\"TeamAttributes\\\": []\\n}\\n</code>\"\n}\n[/block]\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"4-0\": \"400 Bad Request\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"A user has been updated successfully.\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"1-1\": \"Invalid user type: \\\"IncorrectType\\\"\",\n    \"1-2\": \"The 'Type' parameter that was specified is invalid.\",\n    \"2-2\": \"The 'Role' parameter that was specified is invalid.\",\n    \"2-1\": \"Invalid user role:\\\"IncorrectRole\\\"\",\n    \"3-1\": \"Clients is not available\",\n    \"4-1\": \"CanCreate is not available for admins\",\n    \"5-1\": \"CanCreate is not available for clients\",\n    \"5-0\": \"400 Bad Request\",\n    \"6-1\": \"Incorrect user Type\",\n    \"6-0\": \"400 Bad Request\",\n    \"7-1\": \"Attribute not found, Key=112\",\n    \"7-0\": \"400 Bad Request\",\n    \"9-0\": \"404 Not Found\",\n    \"9-1\": \"Object not found\",\n    \"9-2\": \"A user with the specified key was not found.\",\n    \"3-2\": \"You need the 'Clients' feature to be enabled for your account to create a new client.\",\n    \"4-2\": \"'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default.\",\n    \"5-2\": \"'CanCreate' parameter is not allowed for users of type 'Client'. Clients have read only access.\",\n    \"6-2\": \"The 'Type' parameter that was specified doesn't match the corresponding group [UserType](doc:teammembertype) .\",\n    \"7-2\": \"A team attribute wasn't found.\",\n    \"0-1\": \"\",\n    \"8-0\": \"403 Forbidden\",\n    \"8-1\": \"Access denied\",\n    \"8-2\": \"You can't update a user with with 'Owner role.\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]","createdAt":"2017-03-10T05:11:34.416Z","hidden":false,"link_external":false,"title":"Update a User","version":"5783990d5cbce30e0074e145","api":{"params":[{"type":"int","name":"key","_id":"557672393c8a6317004350fd","ref":"","in":"path","required":true,"desc":"The identifier of the user to be updated.","default":""},{"desc":"List of team attributes with values. All values must be a string type.","default":"","type":"object","name":"TeamAttributes","_id":"58e46c3250bbbd19005c98dd","ref":"","in":"body","required":false},{"_id":"59266bf256aefa0f00f7ddc9","default":"User","desc":"User type. The identifier of the type to assign to the user.","in":"body","name":"Type","ref":"","required":false,"type":"string"}],"results":{"codes":[{"name":"","code":"","language":"text","status":200},{"name":"","code":"Depending on the errors:\n1. Invalid user type:\"IncorrectType\"\n2. Invalid user role:\"IncorrectRole\"\n3. Clients is not available\n4. CanCreate is not available for admins\n5. CanCreate is not available for clients\n6. Incorrect user Type\n7. Attribute not found, Key=112","language":"text","status":400},{"status":404,"language":"text","code":"Object not found"},{"status":403,"language":"text","code":"Access denied"}]},"settings":"","url":"/users/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X POST \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Type\": \"Client\",\n       \"TeamAttributes\": [{\n      \t\"Key\": 1,\n       \t\"Value\": \"15260 Ventura Blvd, Suite 2230\"}]\n   }\nhttps://slemma.com/api/v1/users/25283"}]},"method":"post"},"githubsync":"","order":4,"type":"post","isReference":true,"link_url":"","next":{"pages":[],"description":""},"parentDoc":null,"project":"5783990d5cbce30e0074e144","slug":"update-user","__v":3,"category":"5783990d5cbce30e0074e150","excerpt":"Updates the specified user by passing new values in the request body. Only Groupkey, Role, Type and Team Attributes fields can be updated.","sync_unique":"","childrenPages":[]}

postUpdate a User

Updates the specified user by passing new values in the request body. Only Groupkey, Role, Type and Team Attributes fields can be updated.

Path Params

key:
required
integer
The identifier of the user to be updated.

Body Params

TeamAttributes:
object
List of team attributes with values. All values must be a string type.
Type:
stringUser
User type. The identifier of the type to assign to the user.
[block:callout] { "type": "warning", "title": "Note", "body": "* To update 'TeamAttributes', you must provide en **entire** list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.\n* To delete all attributes, pass TeamAttributes parameter with an empty array/hash.\n<code> \n{\n \"TeamAttributes\": []\n}\n</code>" } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "4-0": "400 Bad Request", "0-0": "200 OK", "0-2": "A user has been updated successfully.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "1-1": "Invalid user type: \"IncorrectType\"", "1-2": "The 'Type' parameter that was specified is invalid.", "2-2": "The 'Role' parameter that was specified is invalid.", "2-1": "Invalid user role:\"IncorrectRole\"", "3-1": "Clients is not available", "4-1": "CanCreate is not available for admins", "5-1": "CanCreate is not available for clients", "5-0": "400 Bad Request", "6-1": "Incorrect user Type", "6-0": "400 Bad Request", "7-1": "Attribute not found, Key=112", "7-0": "400 Bad Request", "9-0": "404 Not Found", "9-1": "Object not found", "9-2": "A user with the specified key was not found.", "3-2": "You need the 'Clients' feature to be enabled for your account to create a new client.", "4-2": "'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default.", "5-2": "'CanCreate' parameter is not allowed for users of type 'Client'. Clients have read only access.", "6-2": "The 'Type' parameter that was specified doesn't match the corresponding group [UserType](doc:teammembertype) .", "7-2": "A team attribute wasn't found.", "0-1": "", "8-0": "403 Forbidden", "8-1": "Access denied", "8-2": "You can't update a user with with 'Owner role." }, "cols": 3, "rows": 10 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



[block:callout] { "type": "warning", "title": "Note", "body": "* To update 'TeamAttributes', you must provide en **entire** list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.\n* To delete all attributes, pass TeamAttributes parameter with an empty array/hash.\n<code> \n{\n \"TeamAttributes\": []\n}\n</code>" } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "4-0": "400 Bad Request", "0-0": "200 OK", "0-2": "A user has been updated successfully.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "1-1": "Invalid user type: \"IncorrectType\"", "1-2": "The 'Type' parameter that was specified is invalid.", "2-2": "The 'Role' parameter that was specified is invalid.", "2-1": "Invalid user role:\"IncorrectRole\"", "3-1": "Clients is not available", "4-1": "CanCreate is not available for admins", "5-1": "CanCreate is not available for clients", "5-0": "400 Bad Request", "6-1": "Incorrect user Type", "6-0": "400 Bad Request", "7-1": "Attribute not found, Key=112", "7-0": "400 Bad Request", "9-0": "404 Not Found", "9-1": "Object not found", "9-2": "A user with the specified key was not found.", "3-2": "You need the 'Clients' feature to be enabled for your account to create a new client.", "4-2": "'CanCreate' parameter is not allowed for users with 'Admin' role. Admins have full access by default.", "5-2": "'CanCreate' parameter is not allowed for users of type 'Client'. Clients have read only access.", "6-2": "The 'Type' parameter that was specified doesn't match the corresponding group [UserType](doc:teammembertype) .", "7-2": "A team attribute wasn't found.", "0-1": "", "8-0": "403 Forbidden", "8-1": "Access denied", "8-2": "You can't update a user with with 'Owner role." }, "cols": 3, "rows": 10 } [/block]
{"_id":"58c2493933d7900f00c1a8ff","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"A user has been deleted successfully.\",\n    \"1-0\": \"403 Forbidden\",\n    \"1-1\": \"Access denied\",\n    \"1-2\": \"Access to the user is denied.\",\n    \"2-0\": \"404 Not Found\",\n    \"2-1\": \"Object not found\",\n    \"2-2\": \"An user with the specified key was not found.\",\n    \"0-1\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","excerpt":"Permanently deletes an user. It cannot be undone. Also immediately deletes any objects (datasets, dashboards, etc.) created by this user.","githubsync":"","next":{"description":"","pages":[]},"order":5,"parentDoc":null,"__v":1,"api":{"settings":"","url":"/users/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/users/25283"}]},"method":"delete","params":[{"name":"key","_id":"557671a8f7851f2f000cd438","ref":"","in":"path","required":true,"desc":"The identifier of the user to be deleted","default":"","type":"int"}],"results":{"codes":[{"name":"","status":200,"language":"text","code":""},{"language":"text","status":403,"code":"Access denied"},{"code":"Object not found","language":"text","status":404}]}},"type":"delete","version":"5783990d5cbce30e0074e145","project":"5783990d5cbce30e0074e144","title":"Delete a User","slug":"delete-user","sync_unique":"","user":"5492aa57f0d1810b0066005f","createdAt":"2017-03-10T06:35:37.170Z","link_url":"","link_external":false,"hidden":false,"isReference":true,"updates":["59529aaba0e05a0041b074a3"],"category":"5783990d5cbce30e0074e150","childrenPages":[]}

deleteDelete a User

Permanently deletes an user. It cannot be undone. Also immediately deletes any objects (datasets, dashboards, etc.) created by this user.

Path Params

key:
required
integer
The identifier of the user to be deleted
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "A user has been deleted successfully.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the user is denied.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "An user with the specified key was not found.", "0-1": "" }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "A user has been deleted successfully.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the user is denied.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "An user with the specified key was not found.", "0-1": "" }, "cols": 3, "rows": 3 } [/block]
{"_id":"5784b5fc87c9280e00903727","isReference":true,"order":6,"updates":[],"__v":8,"body":"## Returns \n\nReturns the list of the users. Each entry in the array is a separate user object. If no users are available, the resulting array will be empty.","link_external":false,"link_url":"","parentDoc":null,"slug":"list-all-users","sync_unique":"","title":"List all Users","createdAt":"2016-07-12T09:18:52.990Z","hidden":false,"next":{"description":"","pages":[]},"category":"5783990d5cbce30e0074e150","excerpt":"Returns a list of your users.","project":"5783990d5cbce30e0074e144","type":"get","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","api":{"examples":{"codes":[{"code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/users\n","language":"curl"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":" [\n  {\n    \"Key\": 398,\n    \"Email\": \"developer@capsidea.com\", \n    \"FirstName\": \"\",\n    \"LastName\": \"\",\n    \"AuthType\": \"Slemma Login\",\n    \"Type\": \"User\",\n    \"Role\": \"Administrator\",\n    \"CreatedAt\": \"2014-09-10 08:01:44.635+0000\",\n    \"CanCreate\": {\n        \"Dashboards\": false,\n        \"DataSet\": true,\n        \"Delivery\": false,\n        \"Integrations\": true,\n        \"Reports\": false,\n        \"Sharing\": false\n    },\n    \"TeamAttributes\":[]\n  },\n  {\n    \"Key\": 9,\n    \"Email\": \"capsideas@gmail.com\",\n    \"FirstName\": \"Slemma\",\n    \"LastName\": \"Admin\",\n    \"AuthType\": \"Slemma Login\",\n    \"Type\": \"User\",\n    \"Role\": \"Owner\",\n    \"GroupKey\": 28,\n    \"CreatedAt\": \"2014-09-10 08:01:29.707+0000\",\n    \"CanCreate\": {\n        \"Dashboards\": false,\n        \"DataSet\": true,\n        \"Delivery\": false,\n        \"Integrations\": true,\n        \"Reports\": false,\n        \"Sharing\": false\n    },\n    \"TeamAttributes\":[]\n  }\n]","name":""}]},"settings":"","url":"/users","auth":"required"},"githubsync":"","childrenPages":[]}

getList all Users

Returns a list of your users.

## Returns Returns the list of the users. Each entry in the array is a separate user object. If no users are available, the resulting array will be empty.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns the list of the users. Each entry in the array is a separate user object. If no users are available, the resulting array will be empty.
{"_id":"578753f3b2f4060e00fa3bb7","order":0,"project":"5783990d5cbce30e0074e144","sync_unique":"","type":"basic","user":"5492aa57f0d1810b0066005f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":""},"body":"Users can be grouped to manage users' access to dashboards/datasets. Groups are helpful to give bulk permissions. By default the user doesn't belong to any group, unless the Group Key is provided. Clients and Users can't belong to the same group. You can create, retrieve, update and delete a group, as well as list all groups. Groups are identified by a unique ID.","excerpt":"","hidden":false,"isReference":true,"__v":3,"createdAt":"2016-07-14T08:57:23.552Z","githubsync":"","parentDoc":null,"version":"5783990d5cbce30e0074e145","category":"57849333b3a5402400fee91e","link_external":false,"link_url":"","slug":"groups","title":"Groups","updates":[],"childrenPages":[]}

Groups


Users can be grouped to manage users' access to dashboards/datasets. Groups are helpful to give bulk permissions. By default the user doesn't belong to any group, unless the Group Key is provided. Clients and Users can't belong to the same group. You can create, retrieve, update and delete a group, as well as list all groups. Groups are identified by a unique ID.
Users can be grouped to manage users' access to dashboards/datasets. Groups are helpful to give bulk permissions. By default the user doesn't belong to any group, unless the Group Key is provided. Clients and Users can't belong to the same group. You can create, retrieve, update and delete a group, as well as list all groups. Groups are identified by a unique ID.
{"_id":"5909739e69014e0f00421748","api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"auth":"required","params":[],"url":"","settings":""},"isReference":true,"order":1,"type":"basic","version":"5783990d5cbce30e0074e145","category":"57849333b3a5402400fee91e","createdAt":"2017-05-03T06:07:26.970Z","link_external":false,"link_url":"","__v":0,"body":"** A Group Object contains the following fields:** \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Key\",\n    \"4-0\": \"Creator\",\n    \"3-0\": \"UsersCount\",\n    \"2-0\": \"CreatedAt\",\n    \"1-0\": \"Name\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"2-1\": \"TimeStamp\",\n    \"3-1\": \"String\",\n    \"4-1\": \"Integer\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The Slemma defined ID representing the group\",\n    \"1-2\": \"Group name\",\n    \"2-2\": \"The group creation time\",\n    \"3-2\": \"The number of users in this group\",\n    \"4-2\": \"The ID of the user, who cerated a group\",\n    \"5-0\": \"[Type](doc:teammembertype)\",\n    \"5-1\": \"String\",\n    \"5-2\": \"The type of the group. Determines if this group is created for grouping clients or users. Possible values are listed [here](doc:teammembertype)\",\n    \"6-0\": \"TeamAttributes\",\n    \"6-1\": \"Array of Objects\",\n    \"6-2\": \"A unique identifier for the team attribute.\",\n    \"8-0\": \"*Name* \",\n    \"9-0\": \"*Value* \",\n    \"8-1\": \"String\",\n    \"9-1\": \"String\",\n    \"8-2\": \"The name of the attribute.\",\n    \"9-2\": \"A value for the team attribute.\",\n    \"7-0\": \"*Key* \",\n    \"7-1\": \"Integer\",\n    \"7-2\": \"A unique identifier for the team attribute.\",\n    \"10-0\": \"MaxNumberOfMembers\",\n    \"10-1\": \"Integer\",\n    \"10-2\": \"Maximum number of users/clients allowed for the group. This value can only be changed by the (Owner)[doc:role] (Administrator)[doc:role] of the team. The default value '10'.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","hidden":false,"next":{"pages":[],"description":""},"parentDoc":null,"project":"5783990d5cbce30e0074e144","slug":"group-object","sync_unique":"","updates":[],"user":"5492aa57f0d1810b0066005f","excerpt":"","githubsync":"","title":"The Group Object","childrenPages":[]}

The Group Object


** A Group Object contains the following fields:** [block:parameters] { "data": { "0-0": "Key", "4-0": "Creator", "3-0": "UsersCount", "2-0": "CreatedAt", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "TimeStamp", "3-1": "String", "4-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined ID representing the group", "1-2": "Group name", "2-2": "The group creation time", "3-2": "The number of users in this group", "4-2": "The ID of the user, who cerated a group", "5-0": "[Type](doc:teammembertype)", "5-1": "String", "5-2": "The type of the group. Determines if this group is created for grouping clients or users. Possible values are listed [here](doc:teammembertype)", "6-0": "TeamAttributes", "6-1": "Array of Objects", "6-2": "A unique identifier for the team attribute.", "8-0": "*Name* ", "9-0": "*Value* ", "8-1": "String", "9-1": "String", "8-2": "The name of the attribute.", "9-2": "A value for the team attribute.", "7-0": "*Key* ", "7-1": "Integer", "7-2": "A unique identifier for the team attribute.", "10-0": "MaxNumberOfMembers", "10-1": "Integer", "10-2": "Maximum number of users/clients allowed for the group. This value can only be changed by the (Owner)[doc:role] (Administrator)[doc:role] of the team. The default value '10'." }, "cols": 3, "rows": 11 } [/block]
** A Group Object contains the following fields:** [block:parameters] { "data": { "0-0": "Key", "4-0": "Creator", "3-0": "UsersCount", "2-0": "CreatedAt", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "TimeStamp", "3-1": "String", "4-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined ID representing the group", "1-2": "Group name", "2-2": "The group creation time", "3-2": "The number of users in this group", "4-2": "The ID of the user, who cerated a group", "5-0": "[Type](doc:teammembertype)", "5-1": "String", "5-2": "The type of the group. Determines if this group is created for grouping clients or users. Possible values are listed [here](doc:teammembertype)", "6-0": "TeamAttributes", "6-1": "Array of Objects", "6-2": "A unique identifier for the team attribute.", "8-0": "*Name* ", "9-0": "*Value* ", "8-1": "String", "9-1": "String", "8-2": "The name of the attribute.", "9-2": "A value for the team attribute.", "7-0": "*Key* ", "7-1": "Integer", "7-2": "A unique identifier for the team attribute.", "10-0": "MaxNumberOfMembers", "10-1": "Integer", "10-2": "Maximum number of users/clients allowed for the group. This value can only be changed by the (Owner)[doc:role] (Administrator)[doc:role] of the team. The default value '10'." }, "cols": 3, "rows": 11 } [/block]
{"_id":"5784939613ac6c2200c06af6","project":"5783990d5cbce30e0074e144","slug":"create-group","title":"Create a Group","type":"put","hidden":false,"isReference":true,"link_url":"","category":"57849333b3a5402400fee91e","link_external":false,"order":2,"parentDoc":null,"sync_unique":"","api":{"examples":{"codes":[{"code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\":\"Group\", \n   \t\t \"Type\" : \"Client\",\n       \"MaxNumberOfMembers\":5,\n       \"TeamAttributes\": [{\n             \"Key\": 2,\n             \"Value\": \"15260 Ventura Blvd, Suite 2230\"\n           },\n           {\n             \"Key\": 3,\n             \"Value\": \"+1 (805) 111-1111\"\n           }]\n      }\nhttps://slemma.com/api/v1/groups","language":"curl"}]},"method":"put","params":[{"desc":"Name of the group","default":"","type":"string","name":"Name","_id":"55767c611ce9e637005014e1","ref":"","in":"body","required":true},{"name":"Type","_id":"55767c611ce9e637005014e0","ref":"","in":"body","required":true,"desc":"The type of the group","default":"User","type":"string"},{"type":"object","name":"TeamAttributes","_id":"58e759e055d9573b007177ba","ref":"","in":"body","required":false,"desc":"List of team attributes with values. All values must be a string type.","default":""},{"name":"MaxNumberOfMembers","ref":"","required":false,"type":"int","_id":"5919354fa46bc90f002b40e6","default":"10","desc":"Maximum number of users/clients allowed for the group.","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"Name\": \"Group\",\n  \"Key\": 424214,\n  \"Type\": \"Client\",\n  \"CreatedAt\": \"2016-06-21 00:00:00.000+0000\",\n  \"UsersCount\": 0,\n  \"Creator\": 25283,\n \t\"TeamAttributes\": [{\n\t\t\t\"Key\": 229,\n\t\t\t\"Value\": \"15260 Ventura Blvd, Suite 2230\"\n\t\t},\n  \t{\n\t\t\t\"Key\": 290,\n\t\t\t\"Value\": \"+1 (805) 111-1111\"\n\t\t}],\n  \"MaxNumberOfMembers\":5\n}","name":""},{"status":400,"language":"text","code":"Depending on the errors:\n1. The Name cannot be empty\n2. Clients is not available\n3. Invalid group type:\"Incorrect Type\"\n4. Attribute not found, Key=112","name":""}]},"settings":"","url":"/groups","auth":"required"},"body":"## Returns\nReturns the new group object. This endpoint will create an empty group. You can use the <code>Update an user</code>  or <code>Create a new user</code> endpoints to add users to the group by providing a Group Key. You can't assign a client and a user the same Group Key.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"0-2\": \"The group has been created successfully.\",\n    \"0-1\": \"A group object\",\n    \"1-1\": \"Clients is not available\",\n    \"2-1\": \"The Name cannot be empty\",\n    \"3-1\": \"Invalid group type:\\\"Incorrect Type\\\"\",\n    \"3-2\": \"The 'Type' parameter that was specified is invalid.\",\n    \"2-2\": \"The field \\\"Name\\\" cannot be empty.\",\n    \"1-2\": \"You need the 'Clients' feature to be enabled for your account to create a group of type'Client'.\",\n    \"4-0\": \"400 Bad Request\",\n    \"4-1\": \"Attribute not found, Key=112\",\n    \"4-2\": \"A team attribute wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","updates":[],"version":"5783990d5cbce30e0074e145","githubsync":"","next":{"description":"","pages":[]},"user":"5492aa57f0d1810b0066005f","createdAt":"2016-07-12T06:52:06.751Z","editedParams":true,"editedParams2":true,"__v":4,"excerpt":"Creates a new empty group","childrenPages":[]}

putCreate a Group

Creates a new empty group

Body Params

Name:
required
string
Name of the group
Type:
required
stringUser
The type of the group
TeamAttributes:
object
List of team attributes with values. All values must be a string type.
MaxNumberOfMembers:
integer10
Maximum number of users/clients allowed for the group.
## Returns Returns the new group object. This endpoint will create an empty group. You can use the <code>Update an user</code> or <code>Create a new user</code> endpoints to add users to the group by providing a Group Key. You can't assign a client and a user the same Group Key. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "0-2": "The group has been created successfully.", "0-1": "A group object", "1-1": "Clients is not available", "2-1": "The Name cannot be empty", "3-1": "Invalid group type:\"Incorrect Type\"", "3-2": "The 'Type' parameter that was specified is invalid.", "2-2": "The field \"Name\" cannot be empty.", "1-2": "You need the 'Clients' feature to be enabled for your account to create a group of type'Client'.", "4-0": "400 Bad Request", "4-1": "Attribute not found, Key=112", "4-2": "A team attribute wasn't found." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns the new group object. This endpoint will create an empty group. You can use the <code>Update an user</code> or <code>Create a new user</code> endpoints to add users to the group by providing a Group Key. You can't assign a client and a user the same Group Key. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "0-2": "The group has been created successfully.", "0-1": "A group object", "1-1": "Clients is not available", "2-1": "The Name cannot be empty", "3-1": "Invalid group type:\"Incorrect Type\"", "3-2": "The 'Type' parameter that was specified is invalid.", "2-2": "The field \"Name\" cannot be empty.", "1-2": "You need the 'Clients' feature to be enabled for your account to create a group of type'Client'.", "4-0": "400 Bad Request", "4-1": "Attribute not found, Key=112", "4-2": "A team attribute wasn't found." }, "cols": 3, "rows": 5 } [/block]
{"_id":"578493a3b5fdbd2d00eb04c5","updates":[],"category":"57849333b3a5402400fee91e","hidden":false,"link_external":false,"sync_unique":"","createdAt":"2016-07-12T06:52:19.348Z","link_url":"","githubsync":"","order":3,"parentDoc":null,"project":"5783990d5cbce30e0074e144","__v":2,"body":"## Returns\nReturns a group object if a valid identifier was provided.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"A group object\",\n    \"0-2\": \"A valid group object has been retrieved successfully.\",\n    \"1-0\": \"404 Not Found\",\n    \"1-1\": \"Object not found\",\n    \"1-2\": \"The group with the specified key wasn't found .\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","editedParams":true,"editedParams2":true,"slug":"retrieve-group","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","title":"Retrieve a Group","type":"get","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/groups/424214"}]},"method":"get","params":[{"in":"path","_id":"55767c611ce9e637005014e1","default":"","desc":"The identifier of the group to be retrieved","name":"key","ref":"","required":true,"type":"int"}],"results":{"codes":[{"name":"","code":"{\n  \"Name\": \"Group\",\n  \"Key\": 424214,\n  \"Type\": \"Client\",\n  \"CreatedAt\": \"2016-06-21 00:00:00.000+0000\",\n  \"UsersCount\": 0,\n  \"Creator\": 25283,\n  \"TeamAttributes\": [{\n\t\t\t\"Key\": 229,\n\t\t\t\"Value\": \"15260 Ventura Blvd, Suite 2230\"\n\t\t},\n  \t{\n\t\t\t\"Key\": 290,\n\t\t\t\"Value\": \"+1 (805) 111-1111\"\n\t\t}],\n  \"MaxNumberOfMembers\": 10\n}","language":"json","status":200},{"code":"Object not found","language":"text","status":404}]},"settings":"","url":"/groups/:key"},"excerpt":"Retrieves the details of an existing group. Supply the unique group key (ID) and Slemma will return the corresponding group information.","isReference":true,"next":{"description":"","pages":[]},"childrenPages":[]}

getRetrieve a Group

Retrieves the details of an existing group. Supply the unique group key (ID) and Slemma will return the corresponding group information.

Path Params

key:
required
integer
The identifier of the group to be retrieved
## Returns Returns a group object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "A group object", "0-2": "A valid group object has been retrieved successfully.", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "The group with the specified key wasn't found ." }, "cols": 3, "rows": 2 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns a group object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "A group object", "0-2": "A valid group object has been retrieved successfully.", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "The group with the specified key wasn't found ." }, "cols": 3, "rows": 2 } [/block]
{"_id":"578493c1b3a5402400fee920","order":4,"project":"5783990d5cbce30e0074e144","slug":"update-group","__v":3,"category":"57849333b3a5402400fee91e","createdAt":"2016-07-12T06:52:49.489Z","isReference":true,"link_external":false,"type":"post","user":"5492aa57f0d1810b0066005f","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"* To update 'TeamAttributes', you must provide en **entire** list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.\\n* To delete all attributes, pass TeamAttributes parameter with an empty array/hash.\\n<code> \\n{\\n  \\\"TeamAttributes\\\": []\\n}\\n</code>\"\n}\n[/block]\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"The group has beed successfully updated.\",\n    \"1-0\": \"400 Bad Request\",\n    \"4-0\": \"404 Not Found\",\n    \"4-1\": \"Object not found\",\n    \"4-2\": \"The group with the specified ID wasn't found.\",\n    \"1-1\": \"The Name cannot be empty\",\n    \"1-2\": \"The field \\\"Name\\\" cannot be empty.\",\n    \"2-1\": \"Change group type is not available\",\n    \"2-0\": \"400 Bad Request\",\n    \"2-2\": \"The Name parameter is one and only parameter you can pass in the request body.\",\n    \"3-0\": \"400 Bad Request\",\n    \"3-1\": \"Attribute not found, Key=112\",\n    \"3-2\": \"A team attribute wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","editedParams2":true,"excerpt":"Updates the specified group by passing new values in the request body. Only Name field can be updated.","link_url":"","sync_unique":"","parentDoc":null,"title":"Update a Group","version":"5783990d5cbce30e0074e145","api":{"method":"post","params":[{"required":true,"desc":"The identifier of the group to be updated","default":"","type":"int","name":"key","_id":"557672393c8a6317004350fd","ref":"","in":"path"},{"type":"string","name":"name","_id":"58e75c74577d500f005f3cce","ref":"","in":"body","required":true,"desc":"The name of the group.","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"language":"text","code":"Depending on the errors:\n1. The Name cannot be empty\n2. Change group type is not available\n3. Attribute not found, Key=112","name":"","status":400},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","url":"/groups/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X POST\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\": \"Group45\",\n     \t \"TeamAttributes\": [{\n             \"Key\": 2,\n             \"Value\": \"55260 Ventura Blvd, Suite 2231\"\n           },\n           {\n             \"Key\": 3,\n             \"Value\": \"+1 (805) 222-2222\"\n           }]\n       }\n   https://slemma.com/api/v1/group/513"}]}},"editedParams":true,"githubsync":"","next":{"description":"","pages":[]},"hidden":false,"updates":["59541284a5bbca002d27aef1"],"childrenPages":[]}

postUpdate a Group

Updates the specified group by passing new values in the request body. Only Name field can be updated.

Path Params

key:
required
integer
The identifier of the group to be updated

Body Params

name:
required
string
The name of the group.
[block:callout] { "type": "warning", "body": "* To update 'TeamAttributes', you must provide en **entire** list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.\n* To delete all attributes, pass TeamAttributes parameter with an empty array/hash.\n<code> \n{\n \"TeamAttributes\": []\n}\n</code>" } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The group has beed successfully updated.", "1-0": "400 Bad Request", "4-0": "404 Not Found", "4-1": "Object not found", "4-2": "The group with the specified ID wasn't found.", "1-1": "The Name cannot be empty", "1-2": "The field \"Name\" cannot be empty.", "2-1": "Change group type is not available", "2-0": "400 Bad Request", "2-2": "The Name parameter is one and only parameter you can pass in the request body.", "3-0": "400 Bad Request", "3-1": "Attribute not found, Key=112", "3-2": "A team attribute wasn't found." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



[block:callout] { "type": "warning", "body": "* To update 'TeamAttributes', you must provide en **entire** list of team attributes and corresponding values. If you pass only attributes that you want to update, all other attributes, which are not provided, will be deleted.\n* To delete all attributes, pass TeamAttributes parameter with an empty array/hash.\n<code> \n{\n \"TeamAttributes\": []\n}\n</code>" } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The group has beed successfully updated.", "1-0": "400 Bad Request", "4-0": "404 Not Found", "4-1": "Object not found", "4-2": "The group with the specified ID wasn't found.", "1-1": "The Name cannot be empty", "1-2": "The field \"Name\" cannot be empty.", "2-1": "Change group type is not available", "2-0": "400 Bad Request", "2-2": "The Name parameter is one and only parameter you can pass in the request body.", "3-0": "400 Bad Request", "3-1": "Attribute not found, Key=112", "3-2": "A team attribute wasn't found." }, "cols": 3, "rows": 5 } [/block]
{"_id":"578493b05ebc7b2d00955f3d","sync_unique":"","__v":2,"category":"57849333b3a5402400fee91e","createdAt":"2016-07-12T06:52:32.629Z","editedParams":true,"editedParams2":true,"slug":"delete-group","updates":["59541363654fb9002b95bd19"],"user":"5492aa57f0d1810b0066005f","api":{"url":"/groups/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/groups/12"}]},"method":"delete","params":[{"type":"int","in":"path","_id":"557671a8f7851f2f000cd438","default":"","desc":"The identifier of the group to be deleted","name":"key","ref":"","required":false}],"results":{"codes":[{"name":"","code":"","language":"json","status":200},{"status":403,"language":"text","code":"Access denied"},{"language":"text","code":"Object not found","status":404}]},"settings":""},"excerpt":"Permanently deletes a group. It cannot be undone.","link_external":false,"parentDoc":null,"title":"Delete a Group","version":"5783990d5cbce30e0074e145","hidden":false,"isReference":true,"link_url":"","next":{"description":"","pages":[]},"order":5,"body":"## Notes\nUsers, which have been belonged to the deleted group will automatically get the <code>0</code> Group Key. This means they will be assigned to 'None' (default) group.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"The group has been deleted successfully.\",\n    \"1-0\": \"403 Forbidden\",\n    \"1-1\": \"Access denied\",\n    \"1-2\": \"Access to the group is denied.\",\n    \"2-0\": \"404 Not Found\",\n    \"2-1\": \"Object not found\",\n    \"2-2\": \"The group with the specified ID wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","githubsync":"","project":"5783990d5cbce30e0074e144","type":"delete","childrenPages":[]}

deleteDelete a Group

Permanently deletes a group. It cannot be undone.

Path Params

key:
integer
The identifier of the group to be deleted
## Notes Users, which have been belonged to the deleted group will automatically get the <code>0</code> Group Key. This means they will be assigned to 'None' (default) group. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The group has been deleted successfully.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the group is denied.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "The group with the specified ID wasn't found." }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



## Notes Users, which have been belonged to the deleted group will automatically get the <code>0</code> Group Key. This means they will be assigned to 'None' (default) group. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The group has been deleted successfully.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the group is denied.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "The group with the specified ID wasn't found." }, "cols": 3, "rows": 3 } [/block]
{"_id":"5784b7f287c9280e00903730","user":"5492aa57f0d1810b0066005f","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"[ \n   {\n    \"Name\": \"All\",\n    \"Key\": 0,\n    \"Type\": \"User\",\n    \"CreatedAt\": \"2016-06-21 00:00:00.000+0000\",\n    \"UsersCount\": 3,\n    \"Creator\": 3,\n    \"TeamAttributes\": [{\n        \"Key\": 22,\n        \"Value\": \"15260 Ventura Blvd, Suite 2230\"\n      },\n      {\n        \"Key\": 20,\n        \"Value\": \"+1 (805) 111-1111\"\n      }]\n  },\n  {\n    \"Name\": \"Group\",\n    \"Key\": 424214,\n    \"Type\": \"Client\",\n    \"CreatedAt\": \"2016-06-21 00:00:00.000+0000\",\n    \"UsersCount\": 3,\n    \"Creator\": 25283,\n    \"TeamAttributes\": [{\n        \"Key\": 22,\n        \"Value\": \"15260 Ventura Blvd, Suite 2230\"\n      },\n      {\n        \"Key\": 20,\n        \"Value\": \"+1 (805) 111-1111\"\n      }],\n    \"MaxNumberOfMembers\":5\n  },\n  {\n  \"Name\": \"Group\",\n  \"Key\": 42414,\n  \"Type\": \"Client\",\n  \"CreatedAt\": \"2016-06-21 00:00:00.000+0000\",\n  \"UsersCount\": 0,\n  \"Creator\": 2523,\n  \"TeamAttributes\": [{\n      \"Key\": 22,\n      \"Value\": \"15260 Ventura Blvd, Suite 2230\"\n    },\n    {\n      \"Key\": 20,\n      \"Value\": \"+1 (805) 111-1111\"\n    }],\n  \"MaxNumberOfMembers\":15\n\t}\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/groups","auth":"required","examples":{"codes":[{"code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/groups","language":"curl"}]},"method":"get"},"body":"## Returns \nReturns the list of the groups. Each entry in the array is a separate user object. If no groups are available, the resulting array will be empty.","excerpt":"Returns a list of your groups","link_url":"","slug":"list-all-groups","updates":[],"next":{"description":"","pages":[]},"type":"get","version":"5783990d5cbce30e0074e145","title":"List all Groups","category":"57849333b3a5402400fee91e","createdAt":"2016-07-12T09:27:14.652Z","githubsync":"","parentDoc":null,"sync_unique":"","__v":8,"hidden":false,"isReference":true,"link_external":false,"order":6,"project":"5783990d5cbce30e0074e144","childrenPages":[]}

getList all Groups

Returns a list of your groups

## Returns Returns the list of the groups. Each entry in the array is a separate user object. If no groups are available, the resulting array will be empty.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns the list of the groups. Each entry in the array is a separate user object. If no groups are available, the resulting array will be empty.
{"_id":"5787692b021efa0e00ebb83f","__v":3,"category":"578496edb5fdbd2d00eb04cc","link_url":"","order":0,"title":"Team","user":"5492aa57f0d1810b0066005f","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]}},"body":"Users, Clients and Objects can be united under a Team - an account that represents a single billing entity (aka Master Team). Creation of the Master Team isn't supported by the API and must be done through the [Slemma App](https://slemma.com).\n\nAs an agency you may need to create the subsidiary teams to provide your end users with the ability to work with data and dashboards as a team. The API supports [creation of the subsidiary teams](doc:create-a-team). Under each subsidiary team you can manage [users](doc:users), [datasets](doc:datasets) and [integrations](doc:integrations) as well as [share Objects](doc:publishing-objects). To do so, your API requests must include your *Subsidiary* Team ID (Team Key), *Subsidiary* Team Secret (TeamSecret) and *Subsidiary* Team SIG parameter (OwnerSIG). You can get these information by calling [/teams](doc:list-all-teams) endpoint.\n\n**To be able to create subsidiary teams you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**","githubsync":"","hidden":false,"project":"5783990d5cbce30e0074e144","type":"basic","createdAt":"2016-07-14T10:27:55.676Z","slug":"team","updates":["5954148af135e5001be8e5da"],"version":"5783990d5cbce30e0074e145","sync_unique":"","excerpt":"","isReference":true,"link_external":false,"next":{"description":"","pages":[]},"parentDoc":null,"childrenPages":[]}

Team


Users, Clients and Objects can be united under a Team - an account that represents a single billing entity (aka Master Team). Creation of the Master Team isn't supported by the API and must be done through the [Slemma App](https://slemma.com). As an agency you may need to create the subsidiary teams to provide your end users with the ability to work with data and dashboards as a team. The API supports [creation of the subsidiary teams](doc:create-a-team). Under each subsidiary team you can manage [users](doc:users), [datasets](doc:datasets) and [integrations](doc:integrations) as well as [share Objects](doc:publishing-objects). To do so, your API requests must include your *Subsidiary* Team ID (Team Key), *Subsidiary* Team Secret (TeamSecret) and *Subsidiary* Team SIG parameter (OwnerSIG). You can get these information by calling [/teams](doc:list-all-teams) endpoint. **To be able to create subsidiary teams you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**
Users, Clients and Objects can be united under a Team - an account that represents a single billing entity (aka Master Team). Creation of the Master Team isn't supported by the API and must be done through the [Slemma App](https://slemma.com). As an agency you may need to create the subsidiary teams to provide your end users with the ability to work with data and dashboards as a team. The API supports [creation of the subsidiary teams](doc:create-a-team). Under each subsidiary team you can manage [users](doc:users), [datasets](doc:datasets) and [integrations](doc:integrations) as well as [share Objects](doc:publishing-objects). To do so, your API requests must include your *Subsidiary* Team ID (Team Key), *Subsidiary* Team Secret (TeamSecret) and *Subsidiary* Team SIG parameter (OwnerSIG). You can get these information by calling [/teams](doc:list-all-teams) endpoint. **To be able to create subsidiary teams you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**
{"_id":"5784972bb3a5402400fee927","order":1,"parentDoc":null,"project":"5783990d5cbce30e0074e144","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"body":"**The Team Object contains the following fields:** \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Key\",\n    \"5-0\": \"[Groups](doc:list-all-groups)\",\n    \"4-0\": \"UserCount\",\n    \"3-0\": \"MaxCount\",\n    \"1-0\": \"Name\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"3-1\": \"Integer\",\n    \"4-1\": \"Integer\",\n    \"5-1\": \"Array of Objects\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The Slemma defined id representing the team\",\n    \"1-2\": \"Team name\",\n    \"3-2\": \"Maximum number of users allowed on this team. Depends on the plan the team owner is subscribed to.\",\n    \"4-2\": \"Total number of users on this team\",\n    \"5-2\": \"An array containing Groups created for the exact team.\",\n    \"6-0\": \"OwnerSIG\",\n    \"6-1\": \"String\",\n    \"6-2\": \"The SIG parameter generated for the Subsidiary Team. The Master Team doesn't have this field.\",\n    \"2-0\": \"Owner\",\n    \"2-1\": \"Integer\",\n    \"2-2\": \"Team Owner\",\n    \"7-0\": \"TeamSecret\",\n    \"7-1\": \"String\",\n    \"7-2\": \"The TeamSecret parameter generated for the Subsidiary Team. The Master Team doesn't have this field.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","createdAt":"2016-07-12T07:07:23.939Z","hidden":false,"isReference":true,"type":"basic","updates":[],"link_url":"","slug":"team-object","sync_unique":"","user":"5492aa57f0d1810b0066005f","category":"578496edb5fdbd2d00eb04cc","excerpt":"","githubsync":"","__v":7,"link_external":false,"title":"The Team Object","version":"5783990d5cbce30e0074e145","childrenPages":[]}

The Team Object


**The Team Object contains the following fields:** [block:parameters] { "data": { "0-0": "Key", "5-0": "[Groups](doc:list-all-groups)", "4-0": "UserCount", "3-0": "MaxCount", "1-0": "Name", "0-1": "Integer", "1-1": "String", "3-1": "Integer", "4-1": "Integer", "5-1": "Array of Objects", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the team", "1-2": "Team name", "3-2": "Maximum number of users allowed on this team. Depends on the plan the team owner is subscribed to.", "4-2": "Total number of users on this team", "5-2": "An array containing Groups created for the exact team.", "6-0": "OwnerSIG", "6-1": "String", "6-2": "The SIG parameter generated for the Subsidiary Team. The Master Team doesn't have this field.", "2-0": "Owner", "2-1": "Integer", "2-2": "Team Owner", "7-0": "TeamSecret", "7-1": "String", "7-2": "The TeamSecret parameter generated for the Subsidiary Team. The Master Team doesn't have this field." }, "cols": 3, "rows": 8 } [/block]
**The Team Object contains the following fields:** [block:parameters] { "data": { "0-0": "Key", "5-0": "[Groups](doc:list-all-groups)", "4-0": "UserCount", "3-0": "MaxCount", "1-0": "Name", "0-1": "Integer", "1-1": "String", "3-1": "Integer", "4-1": "Integer", "5-1": "Array of Objects", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the team", "1-2": "Team name", "3-2": "Maximum number of users allowed on this team. Depends on the plan the team owner is subscribed to.", "4-2": "Total number of users on this team", "5-2": "An array containing Groups created for the exact team.", "6-0": "OwnerSIG", "6-1": "String", "6-2": "The SIG parameter generated for the Subsidiary Team. The Master Team doesn't have this field.", "2-0": "Owner", "2-1": "Integer", "2-2": "Team Owner", "7-0": "TeamSecret", "7-1": "String", "7-2": "The TeamSecret parameter generated for the Subsidiary Team. The Master Team doesn't have this field." }, "cols": 3, "rows": 8 } [/block]
{"_id":"57c6aa937e0b250e000d65c2","__v":3,"isReference":true,"project":"5783990d5cbce30e0074e144","order":2,"slug":"create-a-team","title":"Create a team","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","parentDoc":null,"sync_unique":"","api":{"method":"put","params":[{"desc":"","default":"","type":"string","name":"Name","_id":"57c54beffc81340e00ebf584","ref":"","in":"body","required":true},{"type":"int","_id":"57d63a7e95d3680e00ec1f04","default":"","desc":"The Slemma defined id representing the Client, who will be the owner of the subsidiary team.","in":"body","name":"Owner","ref":"","required":true}],"results":{"codes":[{"language":"json","code":"{\n  \"Key\": 21676,\n  \"Name\": \"New child team\",\n  \"Groups\": \n  \t[   \n      {\n       \"Name\": \"All\",\n       \"Key\": 0,\n       \"CreatedAt\": \"\",\n       \"UsersCount\": 1,\n       \"Creator\": 12554\n  \t\t}\n    ],\n  \"UsersCount\": 1,\n  \"MaxCount\": 30,\n  \"OwnerSIG\": \"bbcd4f12w3y0d00877cd87fd8b97620b72fb022a\",\n  \"TeamSecret\": \"9c3d6a62-2712-8457-810c-29031e049f66\"\n}","name":"","status":200},{"code":"Depending on the errors:\n1. User is not client\n2. Feature 'ChildTeam' disabled\n3. Property 'Owner' cannot be empty\n4. Client not found \n","name":"","status":400,"language":"text"}]},"settings":"","url":"/teams","auth":"required","examples":{"codes":[{"code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\":\"New child team\", \"Owner\" : 12554}\nhttps://slemma.com/api/v1/teams","language":"curl"}]}},"category":"578496edb5fdbd2d00eb04cc","createdAt":"2016-08-31T09:59:47.563Z","githubsync":"","next":{"description":"","pages":[]},"type":"put","updates":[],"body":"## Returns\nReturns the new team object. The result will include the field OwnerSIG for the created team.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"A team object\",\n    \"0-2\": \"The team has been created successfully.\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"4-0\": \"400 Bad Request\",\n    \"1-1\": \"User is not client\",\n    \"2-1\": \"Feature 'ChildTeam' is disabled\",\n    \"3-1\": \"Property 'Owner' cannot be empty\",\n    \"4-1\": \"Client not found\",\n    \"2-2\": \"To be able to create a subsidiary team you need this feature to be enabled for your account.\",\n    \"3-2\": \"The field \\\"Owner\\\" cannot be empty.\",\n    \"1-2\": \"The user identifier specified for the 'Owner' parameter **must** be of type 'Client'.\",\n    \"4-2\": \"Owner (user of type 'Client') with the specified identifier was not found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Creates a new subsidiary team. To create a subsidiary team you have to provide the team Name and the Owner ID. Owners of the subsidiary teams can be only [Clients](doc:teammembertype) who belong to a Master Team.","hidden":false,"link_external":false,"link_url":"","childrenPages":[]}

putCreate a team

Creates a new subsidiary team. To create a subsidiary team you have to provide the team Name and the Owner ID. Owners of the subsidiary teams can be only [Clients](doc:teammembertype) who belong to a Master Team.

Body Params

Name:
required
string
Owner:
required
integer
The Slemma defined id representing the Client, who will be the owner of the subsidiary team.
## Returns Returns the new team object. The result will include the field OwnerSIG for the created team. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "A team object", "0-2": "The team has been created successfully.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "1-1": "User is not client", "2-1": "Feature 'ChildTeam' is disabled", "3-1": "Property 'Owner' cannot be empty", "4-1": "Client not found", "2-2": "To be able to create a subsidiary team you need this feature to be enabled for your account.", "3-2": "The field \"Owner\" cannot be empty.", "1-2": "The user identifier specified for the 'Owner' parameter **must** be of type 'Client'.", "4-2": "Owner (user of type 'Client') with the specified identifier was not found." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns the new team object. The result will include the field OwnerSIG for the created team. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "A team object", "0-2": "The team has been created successfully.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "1-1": "User is not client", "2-1": "Feature 'ChildTeam' is disabled", "3-1": "Property 'Owner' cannot be empty", "4-1": "Client not found", "2-2": "To be able to create a subsidiary team you need this feature to be enabled for your account.", "3-2": "The field \"Owner\" cannot be empty.", "1-2": "The user identifier specified for the 'Owner' parameter **must** be of type 'Client'.", "4-2": "Owner (user of type 'Client') with the specified identifier was not found." }, "cols": 3, "rows": 5 } [/block]
{"_id":"5784970b13ac6c2200c06af8","slug":"retrieve-a-team","updates":["595439bbb330760037c4c7e8"],"user":"5492aa57f0d1810b0066005f","__v":3,"githubsync":"","link_url":"","editedParams":true,"excerpt":"Retrieves the details of an existing team. Supply the unique team key (ID) and Slemma will return the corresponding team information.","hidden":false,"next":{"description":"","pages":[]},"version":"5783990d5cbce30e0074e145","body":"## Returns\nReturns an team object if a valid identifier was provided.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"A team has been retrieved successfully.\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"A team object\",\n    \"2-0\": \"404 Not Found\",\n    \"2-1\": \"Object not found\",\n    \"2-2\": \"A team with the specified key wasn't found.\",\n    \"1-0\": \"403 Forbidden\",\n    \"1-1\": \"Access denied\",\n    \"1-2\": \"Access to the team is denied.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"578496edb5fdbd2d00eb04cc","project":"5783990d5cbce30e0074e144","type":"get","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/teams/15"}]},"method":"get","params":[{"_id":"55767c611ce9e637005014e1","default":"","desc":"The identifier of the team to be retrieved","name":"key","ref":"","required":true,"type":"int","in":"path"}],"results":{"codes":[{"code":"{\n  \"Key\": 15,\n  \"Name\": \"Slemma team\",\n  \"Groups\":\n    [\n      {\n        \"Name\": \"Reader\",\n        \"Key\": 0,\n        \"Type\": \"User\",\n        \"CreatedAt\": \"\",\n        \"UsersCount\": 20,\n        \"Creator\": 0\n      },\n      {\n        \"Name\": \"test\",\n        \"Key\": 28,\n        \"Type\": \"User\",\n        \"CreatedAt\": \"2015-04-01 00:00:00.000+0500\",\n        \"UsersCount\": 2,\n        \"Creator\": 0\n      }\n    ],\n  \"UsersCount\": 23,\n  \"MaxCount\": 50\n}","language":"json","status":200,"name":""},{"language":"text","status":403,"name":"","code":"Access denied"},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","url":"/teams/:key"},"editedParams2":true,"link_external":false,"parentDoc":null,"sync_unique":"","title":"Retrieve a team","createdAt":"2016-07-12T07:06:51.955Z","isReference":true,"order":3,"childrenPages":[]}

getRetrieve a team

Retrieves the details of an existing team. Supply the unique team key (ID) and Slemma will return the corresponding team information.

Path Params

key:
required
integer
The identifier of the team to be retrieved
## Returns Returns an team object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-2": "A team has been retrieved successfully.", "0-0": "200 OK", "0-1": "A team object", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "A team with the specified key wasn't found.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the team is denied." }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns an team object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-2": "A team has been retrieved successfully.", "0-0": "200 OK", "0-1": "A team object", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "A team with the specified key wasn't found.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the team is denied." }, "cols": 3, "rows": 3 } [/block]
{"_id":"598003b39cea430015ae631e","project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","category":"578496edb5fdbd2d00eb04cc","user":"5492aa57f0d1810b0066005f","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-01T04:29:39.746Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"language":"curl","code":"cURL -i -X POST\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\n       \"MaxCount\": 12,\n       \"Features\": {\n          \"DefaultMaxUsersInGroup\": 12,\n          \"Delivery\": false,\n          \"MaxWarmup\": 6\n       },\n       \"Enabled\": true\n      }\n   https://slemma.com/api/v1/teams/513\n"}]},"results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"status":400,"language":"json","code":"","name":""},{"code":"Access denied","language":"text","status":403},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","auth":"required","params":[{"_id":"59800acc9cea430015ae63c2","ref":"","in":"path","required":true,"desc":"The identifier of the team to be updated.","default":"","type":"int","name":"key"},{"_id":"59815242302822002abfbf65","ref":"","in":"body","required":false,"desc":"The maximum number of users and clients in a team.","default":"10","type":"int","name":"MaxCount"},{"_id":"59815242302822002abfbf64","ref":"","in":"body","required":false,"desc":"Enable or disable a team.","default":"true","type":"boolean","name":"Enabled"},{"_id":"5981536ada4e40003c9fb9b3","ref":"","in":"body","required":false,"desc":"List of team features with values.","default":"","type":"object","name":"Features"}],"url":"/teams/:key"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"* Enabling/disabling team features can be executed under the Server Admin credentials (TeamID and SIG) only.\\n* You can enable or disable teams by specifying true or false value for the \\\"Enabled\\\" attribute in the body of the request.\\n* You can change the maximum number of user in the team by specifying an integer value for the \\\"MaxCount\\\" attribute in the body of the request.\\n* You can also control other team features by listing their ids and specifying values in the \\\"Features\\\" object.\\n* In the \\\"Feature\\\" object, you should list the features if their values should be true, otherwise their default values will be set to false.\\n\\nYou can find the complete list of the features and their descriptions by this [link](doc:team-features).\"\n}\n[/block]\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"The team has beed successfully updated.\",\n    \"3-0\": \"404 Not Found\",\n    \"3-1\": \"Object not found\",\n    \"3-2\": \"The team with the specified ID wasn't found.\",\n    \"2-0\": \"403 Forbidden\",\n    \"2-1\": \"Access denied\",\n    \"2-2\": \"Access to the user is denied.\",\n    \"1-0\": \"400 Bad request\",\n    \"1-1\": \"\",\n    \"1-2\": \"A team feature with the specified ID wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"Updates the specified team by passing new values in the request body. Updating team features is available only for standalone solutions. Managing team features is available starting from 8.11.0 Slemma version.","slug":"update-a-team","type":"post","title":"Update a team","__v":3,"parentDoc":null,"childrenPages":[]}

postUpdate a team

Updates the specified team by passing new values in the request body. Updating team features is available only for standalone solutions. Managing team features is available starting from 8.11.0 Slemma version.

Path Params

key:
required
integer
The identifier of the team to be updated.

Body Params

MaxCount:
integer10
The maximum number of users and clients in a team.
Enabled:
booleantrue
Enable or disable a team.
Features:
object
List of team features with values.
[block:callout] { "type": "warning", "title": "Note", "body": "* Enabling/disabling team features can be executed under the Server Admin credentials (TeamID and SIG) only.\n* You can enable or disable teams by specifying true or false value for the \"Enabled\" attribute in the body of the request.\n* You can change the maximum number of user in the team by specifying an integer value for the \"MaxCount\" attribute in the body of the request.\n* You can also control other team features by listing their ids and specifying values in the \"Features\" object.\n* In the \"Feature\" object, you should list the features if their values should be true, otherwise their default values will be set to false.\n\nYou can find the complete list of the features and their descriptions by this [link](doc:team-features)." } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The team has beed successfully updated.", "3-0": "404 Not Found", "3-1": "Object not found", "3-2": "The team with the specified ID wasn't found.", "2-0": "403 Forbidden", "2-1": "Access denied", "2-2": "Access to the user is denied.", "1-0": "400 Bad request", "1-1": "", "1-2": "A team feature with the specified ID wasn't found." }, "cols": 3, "rows": 4 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



[block:callout] { "type": "warning", "title": "Note", "body": "* Enabling/disabling team features can be executed under the Server Admin credentials (TeamID and SIG) only.\n* You can enable or disable teams by specifying true or false value for the \"Enabled\" attribute in the body of the request.\n* You can change the maximum number of user in the team by specifying an integer value for the \"MaxCount\" attribute in the body of the request.\n* You can also control other team features by listing their ids and specifying values in the \"Features\" object.\n* In the \"Feature\" object, you should list the features if their values should be true, otherwise their default values will be set to false.\n\nYou can find the complete list of the features and their descriptions by this [link](doc:team-features)." } [/block] The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The team has beed successfully updated.", "3-0": "404 Not Found", "3-1": "Object not found", "3-2": "The team with the specified ID wasn't found.", "2-0": "403 Forbidden", "2-1": "Access denied", "2-2": "Access to the user is denied.", "1-0": "400 Bad request", "1-1": "", "1-2": "A team feature with the specified ID wasn't found." }, "cols": 3, "rows": 4 } [/block]
{"_id":"57d654dfe2e70e20009cdb13","category":"578496edb5fdbd2d00eb04cc","githubsync":"","parentDoc":null,"updates":[],"__v":1,"createdAt":"2016-09-12T07:10:23.121Z","link_url":"","next":{"description":"","pages":[]},"order":5,"title":"Delete a team","type":"delete","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"A team has been deleted successfully.\",\n    \"1-0\": \"403 Forbidden\",\n    \"2-0\": \"404 Not Found\",\n    \"1-1\": \"Access denied\",\n    \"2-1\": \"Object not found\",\n    \"1-2\": \"Access to the team is denied.\",\n    \"2-2\": \"A team with the specified key wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","hidden":false,"project":"5783990d5cbce30e0074e144","slug":"delete-a-team","excerpt":"Permanently deletes a subsidiary team. It cannot be undone.","api":{"results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"code":"Access denied","language":"text","status":403},{"code":"Object not found","language":"text","status":404}]},"settings":"","url":"/teams/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/teams/12"}]},"method":"delete","params":[{"default":"","desc":"The identifier of the child team to be deleted","in":"path","name":"key","ref":"","required":true,"type":"int","_id":"557671a8f7851f2f000cd438"}]},"isReference":true,"link_external":false,"sync_unique":"","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","childrenPages":[]}

deleteDelete a team

Permanently deletes a subsidiary team. It cannot be undone.

Path Params

key:
required
integer
The identifier of the child team to be deleted
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "A team has been deleted successfully.", "1-0": "403 Forbidden", "2-0": "404 Not Found", "1-1": "Access denied", "2-1": "Object not found", "1-2": "Access to the team is denied.", "2-2": "A team with the specified key wasn't found." }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "A team has been deleted successfully.", "1-0": "403 Forbidden", "2-0": "404 Not Found", "1-1": "Access denied", "2-1": "Object not found", "1-2": "Access to the team is denied.", "2-2": "A team with the specified key wasn't found." }, "cols": 3, "rows": 3 } [/block]
{"_id":"5784975f92edb92200e610ff","link_url":"","type":"get","version":"5783990d5cbce30e0074e145","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/teams"}]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"Key\": 21846,\n    \"Name\": \"TeamCheckTdScenario\",\n    \"Groups\": \n    \t[      \n        {\n         \"Name\": \"All\",\n         \"Key\": 0,\n         \"Type\": \"User\",\n         \"CreatedAt\": \"\",\n         \"UsersCount\": 1,\n         \"Creator\": 39679\n    \t\t}\n     \t],\n    \"UsersCount\": 1,\n    \"MaxCount\": 30,\n    \"OwnerSIG\": \"bdb1992382f00016c78a0bb16982b1dae6435223\",\n    \"TeamSecret\": \"9c3d6a62-2712-5124-810c-29031e049f66\"\n  },  \n  {\n    \"Key\": 15,\n    \"Name\": \"Slemma team\",\n    \"Groups\":\n      [\n        {\n          \"Name\": \"Reader\",\n          \"Key\": 0,\n          \"Type\": \"User\",\n          \"CreatedAt\": \"\",\n          \"UsersCount\": 20,\n          \"Creator\": 0\n        },\n        {\n          \"Name\": \"test\",\n          \"Key\": 28,\n          \"Type\": \"User\",\n          \"CreatedAt\": \"2015-04-01 00:00:00.000+0500\",\n          \"UsersCount\": 2,\n          \"Creator\": 0\n        }\n      ],\n    \"UsersCount\": 23,\n    \"MaxCount\": 50\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/teams"},"category":"578496edb5fdbd2d00eb04cc","isReference":true,"link_external":false,"project":"5783990d5cbce30e0074e144","slug":"list-all-teams","sync_unique":"","createdAt":"2016-07-12T07:08:15.552Z","excerpt":"Retrieves information about teams, including all subsidiary teams and a master team.","hidden":false,"parentDoc":null,"order":6,"title":"List all teams","__v":4,"body":"## Returns\nReturns the team objects including the team key (Team ID).","next":{"description":"","pages":[]},"githubsync":"","updates":[],"user":"5492aa57f0d1810b0066005f","childrenPages":[]}

getList all teams

Retrieves information about teams, including all subsidiary teams and a master team.

## Returns Returns the team objects including the team key (Team ID).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns the team objects including the team key (Team ID).
{"_id":"58c0fbbcb36d8c0f006fd77b","order":0,"title":"Team Attributes","type":"basic","version":"5783990d5cbce30e0074e145","createdAt":"2017-03-09T06:52:44.676Z","githubsync":"","link_external":false,"isReference":false,"updates":["59543ca06ed4d9001b3e7c7c"],"user":"5492aa57f0d1810b0066005f","api":{"url":"","results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[]},"category":"58c0f93d84a3590f00c0cfd0","excerpt":"","hidden":false,"sync_unique":"","link_url":"","next":{"pages":[],"description":""},"parentDoc":null,"slug":"team-attributes","__v":1,"body":"Within a team you can use additional attributes to filter data (Team Attributes). The usage of team attributes covers a lot of different cases. For example, you may want users or clients see data filtered depending on what user is viewing the dashboard. By default, this row-level permissions is based on the user email address or individual ID. But what if you have other grouping attributes like people from different departments or regions or your clients which belong to the same company? By providing team attributes, you will be able to set up row-level permissions based on any attribute value you have in your datasets. \n\nTeam attributes specified for a group have a higher priority. It means that if the group of uses has a team attribute associated with it, the data will be filtered based on these attributes values first, even if the users within this group have other team attributes associated with them. \n\nThe API currently supports creation, updating and deleting Team Attributes. You can creating team attributes in Master team or each subsidiary teams. Attributes are identified by an unique ID.","project":"5783990d5cbce30e0074e144","childrenPages":[]}

Team Attributes


Within a team you can use additional attributes to filter data (Team Attributes). The usage of team attributes covers a lot of different cases. For example, you may want users or clients see data filtered depending on what user is viewing the dashboard. By default, this row-level permissions is based on the user email address or individual ID. But what if you have other grouping attributes like people from different departments or regions or your clients which belong to the same company? By providing team attributes, you will be able to set up row-level permissions based on any attribute value you have in your datasets. Team attributes specified for a group have a higher priority. It means that if the group of uses has a team attribute associated with it, the data will be filtered based on these attributes values first, even if the users within this group have other team attributes associated with them. The API currently supports creation, updating and deleting Team Attributes. You can creating team attributes in Master team or each subsidiary teams. Attributes are identified by an unique ID.
Within a team you can use additional attributes to filter data (Team Attributes). The usage of team attributes covers a lot of different cases. For example, you may want users or clients see data filtered depending on what user is viewing the dashboard. By default, this row-level permissions is based on the user email address or individual ID. But what if you have other grouping attributes like people from different departments or regions or your clients which belong to the same company? By providing team attributes, you will be able to set up row-level permissions based on any attribute value you have in your datasets. Team attributes specified for a group have a higher priority. It means that if the group of uses has a team attribute associated with it, the data will be filtered based on these attributes values first, even if the users within this group have other team attributes associated with them. The API currently supports creation, updating and deleting Team Attributes. You can creating team attributes in Master team or each subsidiary teams. Attributes are identified by an unique ID.
{"_id":"58c0f97a2c3c720f00768a23","githubsync":"","isReference":false,"parentDoc":null,"user":"5492aa57f0d1810b0066005f","excerpt":"","category":"58c0f93d84a3590f00c0cfd0","hidden":false,"link_url":"","project":"5783990d5cbce30e0074e144","sync_unique":"","body":"**The Team Attributes Object contains the following fields:** \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"Name\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Team attribute name.\",\n    \"0-0\": \"Key\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"The Slemma defined id representing the team attribute.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","order":1,"title":"The Team Attributes Object","type":"basic","updates":[],"__v":0,"createdAt":"2017-03-09T06:43:06.025Z","link_external":false,"next":{"description":"","pages":[]},"slug":"team-attributes-object","version":"5783990d5cbce30e0074e145","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"childrenPages":[]}

The Team Attributes Object


**The Team Attributes Object contains the following fields:** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "1-0": "Name", "1-1": "String", "1-2": "Team attribute name.", "0-0": "Key", "0-1": "Integer", "0-2": "The Slemma defined id representing the team attribute." }, "cols": 3, "rows": 2 } [/block]
**The Team Attributes Object contains the following fields:** [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "1-0": "Name", "1-1": "String", "1-2": "Team attribute name.", "0-0": "Key", "0-1": "Integer", "0-2": "The Slemma defined id representing the team attribute." }, "cols": 3, "rows": 2 } [/block]
{"_id":"58c0f9934153f90f00c177ee","updates":[],"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"0-1\": \"A team attribute object\",\n    \"1-1\": \"This Name already in use\",\n    \"2-1\": \"Name cannot be empty\",\n    \"1-2\": \"A team attribute with the specified name already exists.\",\n    \"2-2\": \"The field \\\"Name\\\" cannot be empty.\",\n    \"0-2\": \"A team attribute has been created successfully.\",\n    \"3-1\": \"The name can not consist of a single space\",\n    \"3-0\": \"400 Bad Request\",\n    \"3-2\": \"The Name parameter cannot be a white space.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","category":"58c0f93d84a3590f00c0cfd0","link_external":false,"title":"Create a team attribute","githubsync":"","project":"5783990d5cbce30e0074e144","type":"put","user":"5492aa57f0d1810b0066005f","hidden":false,"isReference":false,"link_url":"","next":{"pages":[],"description":""},"__v":3,"api":{"auth":"required","examples":{"codes":[{"code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\":\"New team attribute\"}\nhttps://slemma.com/api/v1/team-attributes/","language":"curl"}]},"method":"put","params":[{"type":"string","name":"Name","_id":"58e46d902aee6b0f00444558","ref":"","in":"body","required":true,"desc":"Team attribute name","default":""}],"results":{"codes":[{"language":"json","code":"{\n  \"Key\": 21676,\n  \"Name\": \"New team attribute\"\n}","name":"","status":200},{"status":400,"language":"text","code":"Depending on the errors:\n1. Name cannot be empty\n2. This name already use\n3. The field \"Name\" cannot consist of single spaces","name":""}]},"settings":"","url":"/team-attributes"},"createdAt":"2017-03-09T06:43:31.002Z","excerpt":"Creates a new Team Attribute. To create a team attribute you have to provide the team attribute Name.","parentDoc":null,"sync_unique":"","version":"5783990d5cbce30e0074e145","order":2,"slug":"create-team-attribute","childrenPages":[]}

putCreate a team attribute

Creates a new Team Attribute. To create a team attribute you have to provide the team attribute Name.

Body Params

Name:
required
string
Team attribute name
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "0-1": "A team attribute object", "1-1": "This Name already in use", "2-1": "Name cannot be empty", "1-2": "A team attribute with the specified name already exists.", "2-2": "The field \"Name\" cannot be empty.", "0-2": "A team attribute has been created successfully.", "3-1": "The name can not consist of a single space", "3-0": "400 Bad Request", "3-2": "The Name parameter cannot be a white space." }, "cols": 3, "rows": 4 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "0-1": "A team attribute object", "1-1": "This Name already in use", "2-1": "Name cannot be empty", "1-2": "A team attribute with the specified name already exists.", "2-2": "The field \"Name\" cannot be empty.", "0-2": "A team attribute has been created successfully.", "3-1": "The name can not consist of a single space", "3-0": "400 Bad Request", "3-2": "The Name parameter cannot be a white space." }, "cols": 3, "rows": 4 } [/block]
{"_id":"58c0f9a44153f90f00c177ef","link_url":"","next":{"pages":[],"description":""},"sync_unique":"","api":{"params":[{"required":true,"type":"int","_id":"58c10ffa4153f90f00c179af","default":"","desc":"The identifier of the team attribute to be retrieved.","in":"path","name":"key","ref":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"Key\": 4231,\n  \"Name\": \"New team attribute\"\n}","name":""},{"language":"text","code":"Object not found","status":404}]},"settings":"","url":"/team-attributes/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/team-attributes/4231"}]},"method":"get"},"order":3,"project":"5783990d5cbce30e0074e144","type":"get","parentDoc":null,"title":"Retrieve a team attribute","__v":1,"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"A team attribute has been retrieved successfully.\",\n    \"0-0\": \"200 OK\",\n    \"1-0\": \"404 Not Found\",\n    \"1-1\": \"Object not found\",\n    \"1-2\": \"A team attribute with the specified key wasn't found.\",\n    \"0-1\": \"A team attribute object\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","category":"58c0f93d84a3590f00c0cfd0","createdAt":"2017-03-09T06:43:48.309Z","hidden":false,"slug":"retrieve-attribute","updates":[],"user":"5492aa57f0d1810b0066005f","excerpt":"Retrieves the details of an existing team attribute. Supply the unique attribute key (ID) and Slemma will return the corresponding team attribute information.","githubsync":"","isReference":false,"link_external":false,"version":"5783990d5cbce30e0074e145","childrenPages":[]}

getRetrieve a team attribute

Retrieves the details of an existing team attribute. Supply the unique attribute key (ID) and Slemma will return the corresponding team attribute information.

Path Params

key:
required
integer
The identifier of the team attribute to be retrieved.
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-2": "A team attribute has been retrieved successfully.", "0-0": "200 OK", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "A team attribute with the specified key wasn't found.", "0-1": "A team attribute object" }, "cols": 3, "rows": 2 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-2": "A team attribute has been retrieved successfully.", "0-0": "200 OK", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "A team attribute with the specified key wasn't found.", "0-1": "A team attribute object" }, "cols": 3, "rows": 2 } [/block]
{"_id":"58c0f9fa53d2390f002dfdc2","parentDoc":null,"order":4,"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"\",\n    \"2-1\": \"Name cannot be empty\",\n    \"1-1\": \"This name already in use\",\n    \"4-0\": \"404 Not Found\",\n    \"4-1\": \"Object not found\",\n    \"4-2\": \"A team attribute with the specified key wasn't found.\",\n    \"2-2\": \"The field \\\"Name\\\" cannot be empty.\",\n    \"1-2\": \"A team attribute with the specified name already exists.\",\n    \"0-2\": \"A team attribute has been updated successfully.\",\n    \"3-1\": \"The name can not consist of single spaces\",\n    \"3-0\": \"400 Bad Request\",\n    \"3-2\": \"The Name parameter cannot be a one white space.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","category":"58c0f93d84a3590f00c0cfd0","excerpt":"Updates the specified team attribute by passing new values in the request body. Only Name field can be updated.","hidden":false,"isReference":false,"link_external":false,"title":"Update a team attribute","type":"post","api":{"url":"/team-attributes/:key","auth":"required","examples":{"codes":[{"code":"cURL -i -X POST  \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\": \"A new Name\"}\nhttps://slemma.com/api/v1/team-attributes/4231","language":"curl"}]},"method":"post","params":[{"ref":"","required":true,"type":"int","_id":"58c110ae84a3590f00c0d117","default":"","desc":"The identifier of the team attribute to be updated.","in":"path","name":"key"},{"desc":"Team attribute name.","in":"body","name":"Name","ref":"","required":true,"type":"string","_id":"58e4707f2ee7281b0043ef05","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"status":400,"language":"text","code":"Depending on the errors:\n1. Name cannot be empty\n2. This name already use\n3. The name can not consist of single spaces","name":""},{"status":404,"language":"text","code":"Object not found"}]},"settings":""},"slug":"update-team-attribute","updates":[],"user":"5492aa57f0d1810b0066005f","__v":2,"githubsync":"","link_url":"","next":{"pages":[],"description":""},"project":"5783990d5cbce30e0074e144","sync_unique":"","version":"5783990d5cbce30e0074e145","createdAt":"2017-03-09T06:45:14.481Z","childrenPages":[]}

postUpdate a team attribute

Updates the specified team attribute by passing new values in the request body. Only Name field can be updated.

Path Params

key:
required
integer
The identifier of the team attribute to be updated.

Body Params

Name:
required
string
Team attribute name.
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "0-0": "200 OK", "0-1": "", "2-1": "Name cannot be empty", "1-1": "This name already in use", "4-0": "404 Not Found", "4-1": "Object not found", "4-2": "A team attribute with the specified key wasn't found.", "2-2": "The field \"Name\" cannot be empty.", "1-2": "A team attribute with the specified name already exists.", "0-2": "A team attribute has been updated successfully.", "3-1": "The name can not consist of single spaces", "3-0": "400 Bad Request", "3-2": "The Name parameter cannot be a one white space." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "0-0": "200 OK", "0-1": "", "2-1": "Name cannot be empty", "1-1": "This name already in use", "4-0": "404 Not Found", "4-1": "Object not found", "4-2": "A team attribute with the specified key wasn't found.", "2-2": "The field \"Name\" cannot be empty.", "1-2": "A team attribute with the specified name already exists.", "0-2": "A team attribute has been updated successfully.", "3-1": "The name can not consist of single spaces", "3-0": "400 Bad Request", "3-2": "The Name parameter cannot be a one white space." }, "cols": 3, "rows": 5 } [/block]
{"_id":"58c1206284a3590f00c0d1f2","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"2-0\": \"404 Not Found\",\n    \"0-1\": \"\",\n    \"2-1\": \"Object not found\",\n    \"2-2\": \"A team attribute with the specified key wasn't found.\",\n    \"0-2\": \"A team attribute has been deleted successfully.\",\n    \"1-0\": \"403 Forbidden\",\n    \"1-2\": \"Access to the team attribute with the specified key is denied. Team attribute doesn't belong to your team.\",\n    \"1-1\": \"Access denied\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","createdAt":"2017-03-09T09:29:06.673Z","isReference":false,"title":"Delete a team attribute","version":"5783990d5cbce30e0074e145","sync_unique":"","user":"5492aa57f0d1810b0066005f","__v":1,"api":{"url":"/team-attributes/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/team-attributes/4231"}]},"method":"delete","params":[{"type":"int","_id":"58c120de84a3590f00c0d234","default":"","desc":"The identifier of the team attribute to be deleted.","in":"path","name":"key","ref":"","required":true}],"results":{"codes":[{"status":200,"name":"","code":"","language":"text"},{"code":"Object not found","language":"text","status":404,"name":""},{"status":403,"language":"text","code":"Access denied"}]},"settings":""},"githubsync":"","hidden":false,"project":"5783990d5cbce30e0074e144","category":"58c0f93d84a3590f00c0cfd0","order":5,"type":"delete","updates":[],"parentDoc":null,"slug":"delete-team-attribute","excerpt":"Permanently deletes a team attribute. It cannot be undone.","link_external":false,"link_url":"","next":{"pages":[],"description":""},"childrenPages":[]}

deleteDelete a team attribute

Permanently deletes a team attribute. It cannot be undone.

Path Params

key:
required
integer
The identifier of the team attribute to be deleted.
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "2-0": "404 Not Found", "0-1": "", "2-1": "Object not found", "2-2": "A team attribute with the specified key wasn't found.", "0-2": "A team attribute has been deleted successfully.", "1-0": "403 Forbidden", "1-2": "Access to the team attribute with the specified key is denied. Team attribute doesn't belong to your team.", "1-1": "Access denied" }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "2-0": "404 Not Found", "0-1": "", "2-1": "Object not found", "2-2": "A team attribute with the specified key wasn't found.", "0-2": "A team attribute has been deleted successfully.", "1-0": "403 Forbidden", "1-2": "Access to the team attribute with the specified key is denied. Team attribute doesn't belong to your team.", "1-1": "Access denied" }, "cols": 3, "rows": 3 } [/block]
{"_id":"58c0fa103384df0f0000e8ed","slug":"list-all-team-attributes","body":"Returns the list of the team attributes. Each entry in the array is a separate team attribute object. If no team attributes are available, the resulting array will be empty.\n\nTest in the API Explorer","category":"58c0f93d84a3590f00c0cfd0","createdAt":"2017-03-09T06:45:36.943Z","hidden":false,"version":"5783990d5cbce30e0074e145","githubsync":"","isReference":false,"next":{"pages":[],"description":""},"order":6,"type":"get","user":"5492aa57f0d1810b0066005f","__v":0,"excerpt":"Returns a list of team attributes for all users on your team.","link_external":false,"link_url":"","sync_unique":"","title":"List all team attributes","updates":[],"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"Key\": 4231,\n    \"Name\": \"First team attribute\"\n  }, \n  {\n    \"Key\": 4232,\n    \"Name\": \"Second team attribute\"\n  }\n]","name":""}]},"settings":"","url":"/team-attributes","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json   \nhttps://slemma.com/api/v1/team-attributes"}]},"method":"get","params":[]},"parentDoc":null,"project":"5783990d5cbce30e0074e144","childrenPages":[]}

getList all team attributes

Returns a list of team attributes for all users on your team.

Returns the list of the team attributes. Each entry in the array is a separate team attribute object. If no team attributes are available, the resulting array will be empty. Test in the API Explorer

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Returns the list of the team attributes. Each entry in the array is a separate team attribute object. If no team attributes are available, the resulting array will be empty. Test in the API Explorer
{"_id":"57b2c8282b27c50e0096abe3","isReference":true,"title":"Objects","updates":[],"version":"5783990d5cbce30e0074e145","body":"Objects are anything you can create and share in Slemma. The types of the Objects are listed [here](doc:object-type). Each object has its own list of fields, however only attributes that are necessary for [sharing Objects](doc:publishing-objects) are listed in this documentation. \n\nReports, Dashboards, and Presentations have the following attributes that are specific for these types of Objects: ShareUrl, ShareUrlCreator, ShareUrlCreateAt. These attributes appear if the [shared link](doc:grant-access-by-link) is created for this Object.\nDatasets, Integrations and Reports have [ExtType](doc:exttype) attribute, which defines the type of connector for Integrations and Datasets (ex. MySql, Google Drive and etc.) and the type of a chart for Reports (ex. Line chart, Bar chart and etc.).\n\nYou can retrieve, delete an Object as well as list all Objects. To create an Object refer to a corresponding resource: Integrations or Datasets.","createdAt":"2016-08-16T08:00:40.349Z","slug":"objects","user":"5492aa57f0d1810b0066005f","category":"57b2c7dbc9a4551700b9682b","link_url":"","hidden":false,"link_external":false,"project":"5783990d5cbce30e0074e144","type":"basic","api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"excerpt":"","githubsync":"","order":0,"parentDoc":null,"sync_unique":"","__v":0,"childrenPages":[]}

Objects


Objects are anything you can create and share in Slemma. The types of the Objects are listed [here](doc:object-type). Each object has its own list of fields, however only attributes that are necessary for [sharing Objects](doc:publishing-objects) are listed in this documentation. Reports, Dashboards, and Presentations have the following attributes that are specific for these types of Objects: ShareUrl, ShareUrlCreator, ShareUrlCreateAt. These attributes appear if the [shared link](doc:grant-access-by-link) is created for this Object. Datasets, Integrations and Reports have [ExtType](doc:exttype) attribute, which defines the type of connector for Integrations and Datasets (ex. MySql, Google Drive and etc.) and the type of a chart for Reports (ex. Line chart, Bar chart and etc.). You can retrieve, delete an Object as well as list all Objects. To create an Object refer to a corresponding resource: Integrations or Datasets.
Objects are anything you can create and share in Slemma. The types of the Objects are listed [here](doc:object-type). Each object has its own list of fields, however only attributes that are necessary for [sharing Objects](doc:publishing-objects) are listed in this documentation. Reports, Dashboards, and Presentations have the following attributes that are specific for these types of Objects: ShareUrl, ShareUrlCreator, ShareUrlCreateAt. These attributes appear if the [shared link](doc:grant-access-by-link) is created for this Object. Datasets, Integrations and Reports have [ExtType](doc:exttype) attribute, which defines the type of connector for Integrations and Datasets (ex. MySql, Google Drive and etc.) and the type of a chart for Reports (ex. Line chart, Bar chart and etc.). You can retrieve, delete an Object as well as list all Objects. To create an Object refer to a corresponding resource: Integrations or Datasets.
{"_id":"584a54a9be6ca01b00e9ba70","api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"auth":"required","params":[],"url":""},"body":"A Object contains the following fields: \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Key\",\n    \"2-0\": \"Owner\",\n    \"1-0\": \"Name\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"2-1\": \"Integer\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The Slemma defined id representing the object\",\n    \"1-2\": \"Name of the object\",\n    \"2-2\": \"The Slemma defined id representing the user, who created the object\",\n    \"7-0\": \"ShareUrl\",\n    \"8-0\": \"SharedWith\",\n    \"9-0\": \"*GroupsAccess*\",\n    \"7-1\": \"String\",\n    \"8-1\": \"Array of Objects\",\n    \"9-1\": \"Objects\",\n    \"4-0\": \"[ExtType](doc:exttype)\",\n    \"4-1\": \"String\",\n    \"3-0\": \"[Type](doc:object-type)\",\n    \"3-1\": \"String\",\n    \"3-2\": \"The type of the Object. The possible values are listed [here](doc:object-type).\",\n    \"4-2\": \"An additional attribute to describe Datasets, Integrations and Reports. The possible values are listed [here](doc:exttype).\",\n    \"7-2\": \"The public URL the Object could be accessed by. The attribute is valid for Dashboards, Reports and Presentations only.\",\n    \"8-2\": \"An array containing Users or Groups who has access to that object, with the options described below.\",\n    \"9-2\": \"Array of Group identifiers, each  with specified permissions on the object.\",\n    \"10-0\": \"*UsersAccess*\",\n    \"10-1\": \"Objects\",\n    \"10-2\": \"Array of User identifiers, each with specified permissions on the object.\",\n    \"11-0\": \"AccessOfTeam\",\n    \"11-1\": \"String\",\n    \"11-2\": \"Default permissions on the object applied to all team users that the object belongs to\",\n    \"5-0\": \"ShareUrlCreator\",\n    \"6-0\": \"ShareUrlCreateAt\",\n    \"6-1\": \"TimeStamp\",\n    \"5-1\": \"Integer\",\n    \"5-2\": \"The ID of the user, who cerated a shared URL. The attribute is valid for Dashboards, Reports and Presentations only.\",\n    \"6-2\": \"The share URL creation time. The attribute is valid for Dashboards, Reports and Presentations only.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","order":1,"version":"5783990d5cbce30e0074e145","project":"5783990d5cbce30e0074e144","title":"The Objects Object","type":"basic","__v":0,"next":{"pages":[],"description":""},"parentDoc":null,"category":"57b2c7dbc9a4551700b9682b","githubsync":"","updates":[],"link_external":false,"link_url":"","slug":"the-objects-object","sync_unique":"","createdAt":"2016-12-09T06:52:25.804Z","excerpt":"","hidden":false,"isReference":true,"user":"5492aa57f0d1810b0066005f","childrenPages":[]}

The Objects Object


A Object contains the following fields: [block:parameters] { "data": { "0-0": "Key", "2-0": "Owner", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the object", "1-2": "Name of the object", "2-2": "The Slemma defined id representing the user, who created the object", "7-0": "ShareUrl", "8-0": "SharedWith", "9-0": "*GroupsAccess*", "7-1": "String", "8-1": "Array of Objects", "9-1": "Objects", "4-0": "[ExtType](doc:exttype)", "4-1": "String", "3-0": "[Type](doc:object-type)", "3-1": "String", "3-2": "The type of the Object. The possible values are listed [here](doc:object-type).", "4-2": "An additional attribute to describe Datasets, Integrations and Reports. The possible values are listed [here](doc:exttype).", "7-2": "The public URL the Object could be accessed by. The attribute is valid for Dashboards, Reports and Presentations only.", "8-2": "An array containing Users or Groups who has access to that object, with the options described below.", "9-2": "Array of Group identifiers, each with specified permissions on the object.", "10-0": "*UsersAccess*", "10-1": "Objects", "10-2": "Array of User identifiers, each with specified permissions on the object.", "11-0": "AccessOfTeam", "11-1": "String", "11-2": "Default permissions on the object applied to all team users that the object belongs to", "5-0": "ShareUrlCreator", "6-0": "ShareUrlCreateAt", "6-1": "TimeStamp", "5-1": "Integer", "5-2": "The ID of the user, who cerated a shared URL. The attribute is valid for Dashboards, Reports and Presentations only.", "6-2": "The share URL creation time. The attribute is valid for Dashboards, Reports and Presentations only." }, "cols": 3, "rows": 12 } [/block]
A Object contains the following fields: [block:parameters] { "data": { "0-0": "Key", "2-0": "Owner", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the object", "1-2": "Name of the object", "2-2": "The Slemma defined id representing the user, who created the object", "7-0": "ShareUrl", "8-0": "SharedWith", "9-0": "*GroupsAccess*", "7-1": "String", "8-1": "Array of Objects", "9-1": "Objects", "4-0": "[ExtType](doc:exttype)", "4-1": "String", "3-0": "[Type](doc:object-type)", "3-1": "String", "3-2": "The type of the Object. The possible values are listed [here](doc:object-type).", "4-2": "An additional attribute to describe Datasets, Integrations and Reports. The possible values are listed [here](doc:exttype).", "7-2": "The public URL the Object could be accessed by. The attribute is valid for Dashboards, Reports and Presentations only.", "8-2": "An array containing Users or Groups who has access to that object, with the options described below.", "9-2": "Array of Group identifiers, each with specified permissions on the object.", "10-0": "*UsersAccess*", "10-1": "Objects", "10-2": "Array of User identifiers, each with specified permissions on the object.", "11-0": "AccessOfTeam", "11-1": "String", "11-2": "Default permissions on the object applied to all team users that the object belongs to", "5-0": "ShareUrlCreator", "6-0": "ShareUrlCreateAt", "6-1": "TimeStamp", "5-1": "Integer", "5-2": "The ID of the user, who cerated a shared URL. The attribute is valid for Dashboards, Reports and Presentations only.", "6-2": "The share URL creation time. The attribute is valid for Dashboards, Reports and Presentations only." }, "cols": 3, "rows": 12 } [/block]
{"_id":"57b2d8f98d94953200fd314f","slug":"retrieve-objects","type":"get","createdAt":"2016-08-16T09:12:25.221Z","isReference":true,"link_external":false,"hidden":false,"link_url":"","project":"5783990d5cbce30e0074e144","sync_unique":"","title":"Retrieve an Object","__v":1,"excerpt":"Retrieves the details of an existing object. Supply the unique object key (ID) and Slemma will return the corresponding object information.","updates":[],"user":"5492aa57f0d1810b0066005f","order":2,"version":"5783990d5cbce30e0074e145","category":"57b2c7dbc9a4551700b9682b","githubsync":"","next":{"description":"","pages":[]},"api":{"method":"get","params":[{"desc":"The identifier of the object to be retrieved.","default":"","type":"int","name":"key","_id":"55767c611ce9e637005014e1","ref":"","in":"path","required":true}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"Key\": 170607,\n  \"Name\": \"BigCommerce\",\n  \"Type\": \"Integration\",\n  \"ExtType\": \"BigCommerce\",\n  \"Owner\": 25283,\n  \"SharedWith\": {\n        \"GroupsAccess\": {\n            \"849\": \"View\"\n        },\n        \"UsersAccess\": {\n            \"36756\": \"View\",\n            \"36758\": \"View\"\n        }\n    },\n    \"AccessOfTeam\": \"View\"\n}","name":""},{"status":404,"language":"text","code":"Object not found"},{"status":400,"language":"text","code":"Incorrect parameter 'type'"}]},"settings":"","url":"/objects/:key","auth":"required","examples":{"codes":[{"code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/objects/170607","language":"curl"}]}},"body":"## RETURNS\nReturns an Object if a valid identifier was provided.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"An object has been retrieved successfully.\",\n    \"0-1\": \"An object\",\n    \"1-0\": \"404 Not Found\",\n    \"1-1\": \"Object not found\",\n    \"1-2\": \"An object with the specified key wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","parentDoc":null,"childrenPages":[]}

getRetrieve an Object

Retrieves the details of an existing object. Supply the unique object key (ID) and Slemma will return the corresponding object information.

Path Params

key:
required
integer
The identifier of the object to be retrieved.
## RETURNS Returns an Object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "An object has been retrieved successfully.", "0-1": "An object", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "An object with the specified key wasn't found." }, "cols": 3, "rows": 2 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## RETURNS Returns an Object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "An object has been retrieved successfully.", "0-1": "An object", "1-0": "404 Not Found", "1-1": "Object not found", "1-2": "An object with the specified key wasn't found." }, "cols": 3, "rows": 2 } [/block]
{"_id":"57c548e1eebbdc1700089a05","githubsync":"","next":{"description":"","pages":[]},"parentDoc":null,"project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","user":"5492aa57f0d1810b0066005f","category":"57b2c7dbc9a4551700b9682b","createdAt":"2016-08-30T08:50:41.226Z","isReference":true,"sync_unique":"","title":"Delete an object","type":"delete","updates":[],"__v":2,"excerpt":"Permanently deletes an object. It cannot be undone.","hidden":false,"api":{"results":{"codes":[{"name":"","code":"","language":"text","status":200},{"status":403,"language":"text","code":"Access denied"},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","url":"/objects/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/objects/12"}]},"method":"delete","params":[{"_id":"557671a8f7851f2f000cd438","default":"","desc":"The identifier of the object to be deleted","in":"path","name":"key","ref":"","required":true,"type":"int"}]},"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"An object has been deleted successfully.\",\n    \"1-0\": \"403 Forbidden\",\n    \"1-1\": \"Access denied\",\n    \"1-2\": \"Access to the object is denied.\",\n    \"2-0\": \"404 Not Found\",\n    \"2-1\": \"Object not found\",\n    \"2-2\": \"An object with the specified key wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","link_external":false,"link_url":"","order":3,"slug":"delete-an-object","childrenPages":[]}

deleteDelete an object

Permanently deletes an object. It cannot be undone.

Path Params

key:
required
integer
The identifier of the object to be deleted
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "An object has been deleted successfully.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the object is denied.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "An object with the specified key wasn't found." }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "An object has been deleted successfully.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the object is denied.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "An object with the specified key wasn't found." }, "cols": 3, "rows": 3 } [/block]
{"_id":"57b2d1ee8d94953200fd314e","__v":3,"githubsync":"","order":4,"slug":"list-all-objects","type":"get","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n\t{\n      \"Key\": 151902,\n      \"Name\": \"8ca336cc-6d2c-49f7-bbdb-b04e98e00474\",\n      \"Type\": \"Dataset\",\n      \"ExtType\": \"OneDrive\",\n      \"Owner\": 25283,\n       \"SharedWith\": {\n          \"GroupsAccess\": {\n              \"849\": \"View\"\n          },\n          \"UsersAccess\": {\n              \"36756\": \"View\",\n              \"36758\": \"View\"\n          }\n      },\n      \"AccessOfTeam\": \"View\"\n  },\n  {\n      \"Key\": 140898,\n      \"Name\": \"8ca336cc-6d2c-49f7-bbdb-b04e98e00474\",\n      \"Type\": \"Dataset\",\n      \"ExtType\": \"OneDrive\",\n      \"Owner\": 25283,\n      \"SharedWith\": {\n        \"GroupsAccess\": {\n            \"849\": \"View\"\n        },\n        \"UsersAccess\": {\n            \"36756\": \"Edit\",\n            \"36758\": \"View\"\n        }\n    },\n    \"AccessOfTeam\": \"View\"\n\t},\n  {\n      \"Key\": 170607,\n      \"Name\": \"BigCommerce\",\n      \"Type\": \"Integration\",\n      \"ExtType\": \"BigCommerce\",\n  \t\t\"ShareUrl\": \"https://slemma.com/share/2989f4fb78ed******************4aea42bc40f\",\n  \t\t\"ShareUrlCreator\": 25283,\n\t\t\t\"ShareUrlCreateAt\": \"2016-07-01 12:52:46.568+0000\",\n      \"Owner\": 25283,\n      \"SharedWith\": {\n        \"GroupsAccess\": {\n            \"849\": \"Edit\"\n        },\n        \"UsersAccess\": {\n            \"36756\": \"View\",\n            \"36758\": \"EditWithAccessEdit\"\n        }\n    },\n    \"AccessOfTeam\": \"View\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/objects","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/objects"}]},"method":"get","params":[{"required":false,"type":"boolean","_id":"578f785e1e9a940e003851ce","default":"null","desc":"The default value <code>null</code> returns all Objects available to you. To return only Objects which are [shared](doc:publishing-objects) by you or with you set this parameter to <code>true</code>. Pass <code>false</code> to filter only Objects, created by you, but which have not been shared yet.","in":"query","name":"is_shared","ref":""},{"in":"query","name":"type","ref":"","required":false,"type":"string","_id":"57b2d8338a92cc1700e15410","default":"","desc":"You may optionally request Slemma to return only Objects of a given [type(s)](doc:object-type)."},{"required":false,"type":"int","_id":"57c3fd69d1e0610e0091557d","default":"-1","desc":"Search only Objects which belong to a given folder (pass folder ID). Pass <code>-1</code> to search ignoring folders or <code>0</code> to search in root folder.","in":"query","name":"parent","ref":""}]},"category":"57b2c7dbc9a4551700b9682b","excerpt":"Returns a list of all available to you Objects, i.e. Objects that have been created by you and Objects that are shared with you.","isReference":true,"link_external":false,"parentDoc":null,"sync_unique":"","title":"List all Objects","updates":[],"body":"## RETURNS\nReturns the list of the objects. Each entry in the array is a separate object. If no objects are available, the resulting array will be empty.","next":{"description":"","pages":[]},"project":"5783990d5cbce30e0074e144","createdAt":"2016-08-16T08:42:22.744Z","hidden":false,"link_url":"","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","childrenPages":[]}

getList all Objects

Returns a list of all available to you Objects, i.e. Objects that have been created by you and Objects that are shared with you.

Query Params

is_shared:
booleannull
The default value <code>null</code> returns all Objects available to you. To return only Objects which are [shared](doc:publishing-objects) by you or with you set this parameter to <code>true</code>. Pass <code>false</code> to filter only Objects, created by you, but which have not been shared yet.
type:
string
You may optionally request Slemma to return only Objects of a given [type(s)](doc:object-type).
parent:
integer-1
Search only Objects which belong to a given folder (pass folder ID). Pass <code>-1</code> to search ignoring folders or <code>0</code> to search in root folder.
## RETURNS Returns the list of the objects. Each entry in the array is a separate object. If no objects are available, the resulting array will be empty.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## RETURNS Returns the list of the objects. Each entry in the array is a separate object. If no objects are available, the resulting array will be empty.
{"_id":"57d8f6215a2c4e0e00c3058b","parentDoc":null,"body":"Integrations are apps and databases that you can use to create [Datasets](doc:datasets) in Slemma. The API currently supports only creation Integrations to [databases](doc:ExtType). You can retrieve, create, and update an integration. To delete the integration, you have to call [Objects](doc:delete-an-object) endpoint. Integrations are identified by an unique ID.","order":0,"link_url":"","project":"5783990d5cbce30e0074e144","title":"Integrations","githubsync":"","slug":"integrations","type":"basic","updates":[],"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","auth":"required","params":[],"url":""},"excerpt":"","createdAt":"2016-09-14T07:02:57.293Z","hidden":false,"isReference":true,"link_external":false,"sync_unique":"","__v":0,"category":"578793a5e516ba0e00304591","childrenPages":[]}

Integrations


Integrations are apps and databases that you can use to create [Datasets](doc:datasets) in Slemma. The API currently supports only creation Integrations to [databases](doc:ExtType). You can retrieve, create, and update an integration. To delete the integration, you have to call [Objects](doc:delete-an-object) endpoint. Integrations are identified by an unique ID.
Integrations are apps and databases that you can use to create [Datasets](doc:datasets) in Slemma. The API currently supports only creation Integrations to [databases](doc:ExtType). You can retrieve, create, and update an integration. To delete the integration, you have to call [Objects](doc:delete-an-object) endpoint. Integrations are identified by an unique ID.
{"_id":"57c55992ecba570e00cd8a95","githubsync":"","isReference":true,"link_url":"","next":{"description":"","pages":[]},"sync_unique":"","api":{"url":"","settings":"","results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"auth":"required","params":[]},"category":"578793a5e516ba0e00304591","updates":[],"user":"5492aa57f0d1810b0066005f","order":1,"slug":"the-integration-object","version":"5783990d5cbce30e0074e145","body":"An Integration contains the following fields: \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Key\",\n    \"2-0\": \"Owner\",\n    \"1-0\": \"Name\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"2-1\": \"Integer\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The Slemma defined id representing the Integration\",\n    \"1-2\": \"Name of the Integration\",\n    \"2-2\": \"The Slemma defined id representing the user, who created the Integration\",\n    \"7-0\": \"SharedWith\",\n    \"8-0\": \"*GroupsAcces*\",\n    \"7-1\": \"Array of Objects\",\n    \"8-1\": \"Objects\",\n    \"5-0\": \"[ExtType](doc:exttype)\",\n    \"5-1\": \"String\",\n    \"4-0\": \"Type\",\n    \"4-1\": \"String\",\n    \"4-2\": \"The type of the Object. **Value is 'Integration'.** \",\n    \"5-2\": \"An additional attribute to describe Integrations. The possible values are listed [here](doc:exttype).\",\n    \"7-2\": \"An array containing Users or Groups who has access to that integration, with the options described below.\",\n    \"8-2\": \"Array of Group identifiers, each with specified permissions on the object.\",\n    \"9-0\": \"*UsersAccess*\",\n    \"9-1\": \"Objects\",\n    \"9-2\": \"Array of User identifiers, each with specified permissions on the object.\",\n    \"10-0\": \"AccessOfTeam\",\n    \"10-1\": \"Boolean\",\n    \"10-2\": \"Default permissions on the object applied to all team users that the object belongs to.\",\n    \"6-0\": \"[SourceType](doc:sourcetype)\",\n    \"6-1\": \"String\",\n    \"6-2\": \"The type of the Datasets that will be created based on the Integration. Possible values are listed [here](doc:sourcetype). \\n[Learn more](http://support.slemma.com/knowledge_base/topics/flat-vs-multidimensional).\",\n    \"11-0\": \"ConnectionString\",\n    \"11-1\": \"Object\",\n    \"12-0\": \"*ServerName*\",\n    \"13-0\": \"*User*\",\n    \"14-0\": \"*Password*\",\n    \"15-0\": \"*Port*\",\n    \"16-0\": \"*Database*\",\n    \"17-0\": \"*Driver*\",\n    \"18-0\": \"*UseSSL*\",\n    \"12-1\": \"String\",\n    \"13-1\": \"String\",\n    \"14-1\": \"String\",\n    \"15-1\": \"String\",\n    \"16-1\": \"String\",\n    \"17-1\": \"String\",\n    \"18-1\": \"Boolean\",\n    \"12-2\": \"Server name.\",\n    \"13-2\": \"Username.\",\n    \"14-2\": \"Password.\",\n    \"15-2\": \"Port.\",\n    \"16-2\": \"Database name.\",\n    \"17-2\": \"Database Driver.\",\n    \"18-2\": \"Whether or not to use SSL.\",\n    \"3-0\": \"Parent\",\n    \"3-1\": \"Integer\",\n    \"3-2\": \"The Slemma defined id representing the folder the Integration belongs to.\",\n    \"11-2\": \"Connection string (for DB Integrations only).\",\n    \"20-0\": \"*DriverProperties*\",\n    \"20-1\": \"Object\",\n    \"20-2\": \"Array of the driver properties.\",\n    \"19-0\": \"*UseSSH*\",\n    \"19-1\": \"Boolean\",\n    \"19-2\": \"Whether or not to use SSH.\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]","excerpt":"","hidden":false,"project":"5783990d5cbce30e0074e144","type":"basic","__v":1,"createdAt":"2016-08-30T10:01:54.051Z","link_external":false,"parentDoc":null,"title":"The Integration Object","childrenPages":[]}

The Integration Object


An Integration contains the following fields: [block:parameters] { "data": { "0-0": "Key", "2-0": "Owner", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the Integration", "1-2": "Name of the Integration", "2-2": "The Slemma defined id representing the user, who created the Integration", "7-0": "SharedWith", "8-0": "*GroupsAcces*", "7-1": "Array of Objects", "8-1": "Objects", "5-0": "[ExtType](doc:exttype)", "5-1": "String", "4-0": "Type", "4-1": "String", "4-2": "The type of the Object. **Value is 'Integration'.** ", "5-2": "An additional attribute to describe Integrations. The possible values are listed [here](doc:exttype).", "7-2": "An array containing Users or Groups who has access to that integration, with the options described below.", "8-2": "Array of Group identifiers, each with specified permissions on the object.", "9-0": "*UsersAccess*", "9-1": "Objects", "9-2": "Array of User identifiers, each with specified permissions on the object.", "10-0": "AccessOfTeam", "10-1": "Boolean", "10-2": "Default permissions on the object applied to all team users that the object belongs to.", "6-0": "[SourceType](doc:sourcetype)", "6-1": "String", "6-2": "The type of the Datasets that will be created based on the Integration. Possible values are listed [here](doc:sourcetype). \n[Learn more](http://support.slemma.com/knowledge_base/topics/flat-vs-multidimensional).", "11-0": "ConnectionString", "11-1": "Object", "12-0": "*ServerName*", "13-0": "*User*", "14-0": "*Password*", "15-0": "*Port*", "16-0": "*Database*", "17-0": "*Driver*", "18-0": "*UseSSL*", "12-1": "String", "13-1": "String", "14-1": "String", "15-1": "String", "16-1": "String", "17-1": "String", "18-1": "Boolean", "12-2": "Server name.", "13-2": "Username.", "14-2": "Password.", "15-2": "Port.", "16-2": "Database name.", "17-2": "Database Driver.", "18-2": "Whether or not to use SSL.", "3-0": "Parent", "3-1": "Integer", "3-2": "The Slemma defined id representing the folder the Integration belongs to.", "11-2": "Connection string (for DB Integrations only).", "20-0": "*DriverProperties*", "20-1": "Object", "20-2": "Array of the driver properties.", "19-0": "*UseSSH*", "19-1": "Boolean", "19-2": "Whether or not to use SSH." }, "cols": 3, "rows": 21 } [/block]
An Integration contains the following fields: [block:parameters] { "data": { "0-0": "Key", "2-0": "Owner", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the Integration", "1-2": "Name of the Integration", "2-2": "The Slemma defined id representing the user, who created the Integration", "7-0": "SharedWith", "8-0": "*GroupsAcces*", "7-1": "Array of Objects", "8-1": "Objects", "5-0": "[ExtType](doc:exttype)", "5-1": "String", "4-0": "Type", "4-1": "String", "4-2": "The type of the Object. **Value is 'Integration'.** ", "5-2": "An additional attribute to describe Integrations. The possible values are listed [here](doc:exttype).", "7-2": "An array containing Users or Groups who has access to that integration, with the options described below.", "8-2": "Array of Group identifiers, each with specified permissions on the object.", "9-0": "*UsersAccess*", "9-1": "Objects", "9-2": "Array of User identifiers, each with specified permissions on the object.", "10-0": "AccessOfTeam", "10-1": "Boolean", "10-2": "Default permissions on the object applied to all team users that the object belongs to.", "6-0": "[SourceType](doc:sourcetype)", "6-1": "String", "6-2": "The type of the Datasets that will be created based on the Integration. Possible values are listed [here](doc:sourcetype). \n[Learn more](http://support.slemma.com/knowledge_base/topics/flat-vs-multidimensional).", "11-0": "ConnectionString", "11-1": "Object", "12-0": "*ServerName*", "13-0": "*User*", "14-0": "*Password*", "15-0": "*Port*", "16-0": "*Database*", "17-0": "*Driver*", "18-0": "*UseSSL*", "12-1": "String", "13-1": "String", "14-1": "String", "15-1": "String", "16-1": "String", "17-1": "String", "18-1": "Boolean", "12-2": "Server name.", "13-2": "Username.", "14-2": "Password.", "15-2": "Port.", "16-2": "Database name.", "17-2": "Database Driver.", "18-2": "Whether or not to use SSL.", "3-0": "Parent", "3-1": "Integer", "3-2": "The Slemma defined id representing the folder the Integration belongs to.", "11-2": "Connection string (for DB Integrations only).", "20-0": "*DriverProperties*", "20-1": "Object", "20-2": "Array of the driver properties.", "19-0": "*UseSSH*", "19-1": "Boolean", "19-2": "Whether or not to use SSH." }, "cols": 3, "rows": 21 } [/block]
{"_id":"578e2d420a4b4b0e00f421a5","link_external":false,"link_url":"","type":"put","body":"## Returns\nReturns a new Integration object if the call succeeded.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"An integration object\",\n    \"0-2\": \"An integration has been created successfully.\",\n    \"1-1\": \"Incorrect property ExtType\",\n    \"2-1\": \"Incorrect SourceType for this integration\",\n    \"3-1\": \"The Name cannot be empty\",\n    \"4-1\": \"The SourceType cannot be empty\",\n    \"5-1\": \"This Source type unsupported\",\n    \"6-1\": \"The ConnectionString cannot be empty\",\n    \"7-1\": \"The ServerName cannot be empty\",\n    \"10-1\": \"The 'Driver' and 'ExtType' are inconsistent\",\n    \"1-2\": \"The [ExtType](doc:exttype)  that was specified is invalid.\",\n    \"2-2\": \"The [Source Type](doc:sourcetype) that was specified is invalid.\",\n    \"3-2\": \"The field \\\"Name\\\" cannot be empty.\",\n    \"4-2\": \"The field \\\"SourceType\\\" cannot be empty.\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"4-0\": \"400 Bad Request\",\n    \"5-0\": \"400 Bad Request\",\n    \"6-0\": \"400 Bad Request\",\n    \"7-0\": \"400 Bad Request\",\n    \"10-0\": \"400 Bad Request\",\n    \"5-2\": \"The [Source Type](doc:sourcetype) that was specified was 'ChartConnector'.  Possible values are 'Flat' for MongoDB and 'Cube' for the rest.\",\n    \"6-2\": \"The field \\\"ConnectionString\\\" cannot be empty.\",\n    \"7-2\": \"The field \\\"ServerName\\\" cannot be empty.\",\n    \"8-1\": \"The Database cannot be empty\",\n    \"9-1\": \"The Driver cannot be empty\",\n    \"8-0\": \"400 Bad Request\",\n    \"9-0\": \"400 Bad Request\",\n    \"8-2\": \"The field \\\"Database\\\" cannot be empty.\",\n    \"9-2\": \"The field \\\"Driver\\\" cannot be empty.\",\n    \"10-2\": \"The value that was specified for 'Driver' parameter doesn't match the specified 'ExtType' value. [Check the reference table](doc:exttype).\",\n    \"11-0\": \"400 Bad Request\",\n    \"11-1\": \"For example: The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']\",\n    \"11-2\": \"The value of the property does not match the list of allowed values.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","next":{"description":"","pages":[]},"project":"5783990d5cbce30e0074e144","updates":[],"order":2,"parentDoc":null,"__v":10,"api":{"examples":{"codes":[{"code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\":\"IntMSSQL_\", \"ExtType\" : \"SQLServer\", \"Parent\" : 179735, \n   \t\t\"ConnectionString\" : {\n      \t\t\t\t\t\t\t\t\t\t\t\"ServerName\": \"ssh.example.com\",\n      \t\t\t\t\t\t\t\t\t\t\t\"User\": \"sa\",\n                            \"Password\": \"*****\",\n                            \"Port\": \"5433\",\n                            \"Database\": \"DatabaseName\",\n        \t\t\t\t\t\t\t\t\t\t\"Driver\": \"sqlserver\",                      \n        \t\t\t\t\t\t\t\t\t\t\"UseSSL\": true,\n                            \"DriverProperties\": {\n        \t\t\t\t\t\t\t\t\t\t\t\t\"loginTimeout\": \"12\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n                            },\n       \"SourceType\": \"Cube\"\n      }\nhttps://slemma.com/api/v1/integrations","language":"curl"}]},"method":"put","params":[{"_id":"57c54beffc81340e00ebf584","ref":"","in":"body","required":true,"desc":"Name of the Integration","default":"","type":"string","name":"Name"},{"_id":"57878e1c5286030e00589bf5","ref":"","in":"body","required":true,"desc":"Hash with information on connection details: ServerName, User, Password, Port, Database, Driver, UseSSL","default":"","type":"object","name":"ConnectionString"},{"_id":"57d644bc4340330e00953c16","ref":"","in":"body","required":false,"desc":"The ID of an existing folder to add this Integration to. If nothing is passed, then the Integration will be created in a root folder.","default":"","type":"int","name":"Parent"},{"_id":"57d644bc4340330e00953c15","ref":"","in":"body","required":true,"desc":"An additional attribute to describe Integrations. The possible values are listed [here](doc:exttype). Head to **database** values.","default":"","type":"string","name":"ExtType"},{"_id":"57d8ffa83916800e003dde6b","ref":"","in":"body","required":false,"desc":"Defines the type of datasets that will be created on that Integration.","default":"Cube","type":"string","name":"SourceType"}],"results":{"codes":[{"name":"","code":"{\n   \"Key\": 186893,\n   \"Name\": \"IntMSSQL_\",\n   \"Type\": \"Integration\",\n   \"ExtType\": \"SQLServer\",\n   \"Owner\": 37168,\n   \"SharedWith\":{\n     \"GroupsAccess\": {},\n     \"UsersAccess\": {}\n   \t},\n   \"Parent\": 179735,\n   \"ConnectionString\":    \n  \t{\n      \"ServerName\": \"ssh.example.com\",\n      \"User\": \"sa\",\n      \"Password\": \"*****\",\n      \"Port\": \"5433\",\n      \"Database\": \"DatabaseName\",\n      \"Driver\": \"sqlserver\",\n      \"UseSSL\": true,\n      \"DriverProperties\": {\n        \"loginTimeout\": \"12\"\n\t\t\t}\n   \t},\n   \"SourceType\": \"Cube\"\n}","language":"json","status":200},{"code":"Depending on the errors:\n1. Incorrect property ExtType\n2. Incorrect SourceType for this integration\n3. The Name cannot be empty\n4. The SourceType cannot be empty\n5. This Source type unsupported\n6. The ConnectionString cannot be empty\n7. The ServerName cannot be empty\n8. The Database cannot be empty\n9. The Driver cannot be empty\n10. The 'Driver' and 'ExtType' are inconsistent\n11. The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']","language":"text","status":400,"name":""}]},"settings":"","url":"/integrations","auth":"required"},"category":"578793a5e516ba0e00304591","createdAt":"2016-07-19T13:38:10.847Z","excerpt":"Creates a new Integration Object. The API currently supports only creation Integrations to databases.","isReference":true,"slug":"create-intagration","sync_unique":"","title":"Create an integration","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","githubsync":"","hidden":false,"childrenPages":[]}

putCreate an integration

Creates a new Integration Object. The API currently supports only creation Integrations to databases.

Body Params

Name:
required
string
Name of the Integration
ConnectionString:
required
object
Hash with information on connection details: ServerName, User, Password, Port, Database, Driver, UseSSL
Parent:
integer
The ID of an existing folder to add this Integration to. If nothing is passed, then the Integration will be created in a root folder.
ExtType:
required
string
An additional attribute to describe Integrations. The possible values are listed [here](doc:exttype). Head to **database** values.
SourceType:
stringCube
Defines the type of datasets that will be created on that Integration.
## Returns Returns a new Integration object if the call succeeded. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "An integration object", "0-2": "An integration has been created successfully.", "1-1": "Incorrect property ExtType", "2-1": "Incorrect SourceType for this integration", "3-1": "The Name cannot be empty", "4-1": "The SourceType cannot be empty", "5-1": "This Source type unsupported", "6-1": "The ConnectionString cannot be empty", "7-1": "The ServerName cannot be empty", "10-1": "The 'Driver' and 'ExtType' are inconsistent", "1-2": "The [ExtType](doc:exttype) that was specified is invalid.", "2-2": "The [Source Type](doc:sourcetype) that was specified is invalid.", "3-2": "The field \"Name\" cannot be empty.", "4-2": "The field \"SourceType\" cannot be empty.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "400 Bad Request", "7-0": "400 Bad Request", "10-0": "400 Bad Request", "5-2": "The [Source Type](doc:sourcetype) that was specified was 'ChartConnector'. Possible values are 'Flat' for MongoDB and 'Cube' for the rest.", "6-2": "The field \"ConnectionString\" cannot be empty.", "7-2": "The field \"ServerName\" cannot be empty.", "8-1": "The Database cannot be empty", "9-1": "The Driver cannot be empty", "8-0": "400 Bad Request", "9-0": "400 Bad Request", "8-2": "The field \"Database\" cannot be empty.", "9-2": "The field \"Driver\" cannot be empty.", "10-2": "The value that was specified for 'Driver' parameter doesn't match the specified 'ExtType' value. [Check the reference table](doc:exttype).", "11-0": "400 Bad Request", "11-1": "For example: The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']", "11-2": "The value of the property does not match the list of allowed values." }, "cols": 3, "rows": 12 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns a new Integration object if the call succeeded. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "An integration object", "0-2": "An integration has been created successfully.", "1-1": "Incorrect property ExtType", "2-1": "Incorrect SourceType for this integration", "3-1": "The Name cannot be empty", "4-1": "The SourceType cannot be empty", "5-1": "This Source type unsupported", "6-1": "The ConnectionString cannot be empty", "7-1": "The ServerName cannot be empty", "10-1": "The 'Driver' and 'ExtType' are inconsistent", "1-2": "The [ExtType](doc:exttype) that was specified is invalid.", "2-2": "The [Source Type](doc:sourcetype) that was specified is invalid.", "3-2": "The field \"Name\" cannot be empty.", "4-2": "The field \"SourceType\" cannot be empty.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "400 Bad Request", "7-0": "400 Bad Request", "10-0": "400 Bad Request", "5-2": "The [Source Type](doc:sourcetype) that was specified was 'ChartConnector'. Possible values are 'Flat' for MongoDB and 'Cube' for the rest.", "6-2": "The field \"ConnectionString\" cannot be empty.", "7-2": "The field \"ServerName\" cannot be empty.", "8-1": "The Database cannot be empty", "9-1": "The Driver cannot be empty", "8-0": "400 Bad Request", "9-0": "400 Bad Request", "8-2": "The field \"Database\" cannot be empty.", "9-2": "The field \"Driver\" cannot be empty.", "10-2": "The value that was specified for 'Driver' parameter doesn't match the specified 'ExtType' value. [Check the reference table](doc:exttype).", "11-0": "400 Bad Request", "11-1": "For example: The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']", "11-2": "The value of the property does not match the list of allowed values." }, "cols": 3, "rows": 12 } [/block]
{"_id":"57c55a3089df2b1700ed98a0","project":"5783990d5cbce30e0074e144","sync_unique":"","user":"5492aa57f0d1810b0066005f","__v":3,"createdAt":"2016-08-30T10:04:32.866Z","updates":[],"category":"578793a5e516ba0e00304591","githubsync":"","isReference":true,"link_url":"","next":{"description":"","pages":[]},"parentDoc":null,"title":"Update an integration","version":"5783990d5cbce30e0074e145","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"An integration has been updated successfully.\",\n    \"11-0\": \"404 Not Found\",\n    \"11-1\": \"Object not found\",\n    \"11-2\": \"An Integration with the specified key wasn't found.\",\n    \"10-0\": \"403 Forbidden\",\n    \"10-1\": \"Access denied\",\n    \"10-2\": \"Access to the integration is denied.\",\n    \"3-1\": \"Incorrect SourceType\",\n    \"1-1\": \"Incorrect ExtType\",\n    \"2-1\": \"The 'Name' cannot be empty\",\n    \"4-1\": \"Incorrect Driver\",\n    \"5-1\": \"The 'Driver' is incorrect\",\n    \"6-1\": \"The ServerName cannot be empty\",\n    \"1-2\": \"The [ExtType](doc:exttype)  that was specified is invalid.\",\n    \"3-2\": \"The [Source Type](doc:sourcetype) that was specified is invalid.\",\n    \"2-2\": \"The field \\\"Name\\\" cannot be empty.\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"4-0\": \"400 Bad Request\",\n    \"5-0\": \"400 Bad Request\",\n    \"6-0\": \"400 Bad Request\",\n    \"6-2\": \"The field \\\"ServerName\\\" cannot be empty.\",\n    \"4-2\": \"The [Driver](doc:exttype) that was specified is invalid.\",\n    \"5-2\": \"If you specify incorrect driver.\",\n    \"7-1\": \"The Database cannot be empty\",\n    \"7-0\": \"400 Bad Request\",\n    \"8-0\": \"400 Bad Request\",\n    \"7-2\": \"The field \\\"Database\\\" cannot be empty.\",\n    \"8-1\": \"The Driver cannot be empty\",\n    \"8-2\": \"The field \\\"Driver\\\" cannot be empty.\",\n    \"0-1\": \"An integration object\",\n    \"9-1\": \"The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']\",\n    \"9-2\": \"The value of the property does not match the list of allowed values.\",\n    \"9-0\": \"400 Bad Request\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"Updates the specified integration by passing new values in the request body. Only Name, Parent, ConnectionString fields can be updated.","hidden":false,"link_external":false,"order":3,"slug":"update-an-integration","type":"post","api":{"examples":{"codes":[{"language":"curl","code":"cURL -i -X POST\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\": \"Test\"}\n   https://slemma.com/api/v1/integrations/187915"}]},"method":"post","params":[{"_id":"557672393c8a6317004350fd","ref":"","in":"path","required":true,"desc":"The identifier of the integration to be updated. Test in the API Explorer","default":"","type":"int","name":"key"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"Key\": 187915,\n  \"Name\": \"Test\",\n  \"Type\": \"Integration\",\n  \"ExtType\": \"SQLServer\",\n  \"Owner\": 25283,\n  \"SharedWith\":{\n     \"GroupsAccess\": {\n        \"849\": \"Edit\"},\n     \"UsersAccess\": {\n        \"36757\": \"EditWithAccessEdit\"}\n   \t},\n  \"AccessOfTeam\": \"Edit\",\n  \"ConnectionString\": \n\t\t{\n      \"ServerName\": \"ssh.example.com\",\n      \"User\": \"sa\",\n      \"Password\": \"*****\",\n      \"Port\": \"5433\",\n      \"Database\": \"DatabaseName\",\n      \"Driver\": \"sqlserver\",\n      \"UseSSL\": true,\n      \"DriverProperties\": {\t\t\t\t\n        \"loginTimeout\": \"12\"\n\t\t\t}\n  \t},\n  \"SourceType\": \"Cube\"\n}","name":""},{"code":"Depending on the errors:\n1. Incorrect property ExtType\n2. Incorrect SourceType\n3. Incorrect Driver\n4. The 'Driver' is incorrect\n5. The 'Name' cannot be empty\n6. The ServerName cannot be empty\n7. The Database cannot be empty\n8. The Driver cannot be empty","name":"","status":400,"language":"text"},{"status":403,"language":"text","code":"Access denied"},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","url":"/integrations/:key","auth":"required"},"childrenPages":[]}

postUpdate an integration

Updates the specified integration by passing new values in the request body. Only Name, Parent, ConnectionString fields can be updated.

Path Params

key:
required
integer
The identifier of the integration to be updated. Test in the API Explorer
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "An integration has been updated successfully.", "11-0": "404 Not Found", "11-1": "Object not found", "11-2": "An Integration with the specified key wasn't found.", "10-0": "403 Forbidden", "10-1": "Access denied", "10-2": "Access to the integration is denied.", "3-1": "Incorrect SourceType", "1-1": "Incorrect ExtType", "2-1": "The 'Name' cannot be empty", "4-1": "Incorrect Driver", "5-1": "The 'Driver' is incorrect", "6-1": "The ServerName cannot be empty", "1-2": "The [ExtType](doc:exttype) that was specified is invalid.", "3-2": "The [Source Type](doc:sourcetype) that was specified is invalid.", "2-2": "The field \"Name\" cannot be empty.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "400 Bad Request", "6-2": "The field \"ServerName\" cannot be empty.", "4-2": "The [Driver](doc:exttype) that was specified is invalid.", "5-2": "If you specify incorrect driver.", "7-1": "The Database cannot be empty", "7-0": "400 Bad Request", "8-0": "400 Bad Request", "7-2": "The field \"Database\" cannot be empty.", "8-1": "The Driver cannot be empty", "8-2": "The field \"Driver\" cannot be empty.", "0-1": "An integration object", "9-1": "The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']", "9-2": "The value of the property does not match the list of allowed values.", "9-0": "400 Bad Request" }, "cols": 3, "rows": 12 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "An integration has been updated successfully.", "11-0": "404 Not Found", "11-1": "Object not found", "11-2": "An Integration with the specified key wasn't found.", "10-0": "403 Forbidden", "10-1": "Access denied", "10-2": "Access to the integration is denied.", "3-1": "Incorrect SourceType", "1-1": "Incorrect ExtType", "2-1": "The 'Name' cannot be empty", "4-1": "Incorrect Driver", "5-1": "The 'Driver' is incorrect", "6-1": "The ServerName cannot be empty", "1-2": "The [ExtType](doc:exttype) that was specified is invalid.", "3-2": "The [Source Type](doc:sourcetype) that was specified is invalid.", "2-2": "The field \"Name\" cannot be empty.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "400 Bad Request", "6-2": "The field \"ServerName\" cannot be empty.", "4-2": "The [Driver](doc:exttype) that was specified is invalid.", "5-2": "If you specify incorrect driver.", "7-1": "The Database cannot be empty", "7-0": "400 Bad Request", "8-0": "400 Bad Request", "7-2": "The field \"Database\" cannot be empty.", "8-1": "The Driver cannot be empty", "8-2": "The field \"Driver\" cannot be empty.", "0-1": "An integration object", "9-1": "The value of the property 'value' does not match the list of allowed values - ['value1','value2','value3']", "9-2": "The value of the property does not match the list of allowed values.", "9-0": "400 Bad Request" }, "cols": 3, "rows": 12 } [/block]
{"_id":"57c5664d89df2b1700ed98b4","excerpt":"Retrieves the details of an existing integration. Supply the unique integration key (ID) and Slemma will return the corresponding integration information.","link_external":false,"link_url":"","project":"5783990d5cbce30e0074e144","body":"## RETURNS\nReturns an Integration object if a valid identifier was provided.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"An integration object\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"An integration has been retrieved successfully.\",\n    \"2-0\": \"403 Forbidden\",\n    \"2-1\": \"Access denied\",\n    \"2-2\": \"Access to the integration is denied.\",\n    \"3-0\": \"404 Not Found\",\n    \"3-1\": \"Object not found\",\n    \"3-2\": \"An integration with the specified key wasn't found.\",\n    \"1-0\": \"400 Bad Request\",\n    \"1-1\": \"Parameter is empty\",\n    \"1-2\": \"The parameter \\\"key\\\" cannot be empty.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","category":"578793a5e516ba0e00304591","next":{"description":"","pages":[]},"order":4,"title":"Retrieve an integration","type":"get","createdAt":"2016-08-30T10:56:13.225Z","githubsync":"","hidden":false,"parentDoc":null,"sync_unique":"","updates":[],"user":"5492aa57f0d1810b0066005f","__v":2,"api":{"settings":"","url":"/integrations/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/integrations/170607"}]},"method":"get","params":[{"_id":"55767c611ce9e637005014e1","ref":"","in":"path","required":true,"desc":"The identifier of the integration to be retrieved.","default":"","type":"int","name":"key"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"Key\": 170607,\n   \"Name\": \"IntMSSQL_\",\n   \"Type\": \"Integration\",\n   \"ExtType\": \"SQLServer\",\n   \"Owner\": 37168,\n   \"SharedWith\":{\n     \"GroupsAccess\": {\n        \"849\": \"Edit\"},\n     \"UsersAccess\": {\n        \"36757\": \"EditWithAccessEdit\"}\n   \t},\n   \"AccessOfTeam\": \"Edit\",\n   \"Parent\": 179735,\n   \"ConnectionString\":    {\n      \"ServerName\": \"ssh.example.com\",\n      \"User\": \"sa\",\n      \"Password\": \"*****\",\n      \"Port\": \"5433\",\n      \"Database\": \"DatabaseName\",\n      \"Driver\": \"sqlserver\",\n      \"UseSSL\": true,\n      \"UseSSH\": true,\n      \"SSHPort\": \"5433\",\n      \"DriverProperties\": {\n\t\t\t\t\"xopenStates\": \"false\",\n        \"loginTimeout\": \"12\"\n\t\t\t}\n   },\n   \"SourceType\": \"Cube\"\n}","name":""},{"status":400,"language":"text","code":"Parameter is empty","name":""},{"status":404,"language":"text","code":"Object not found"},{"status":403,"language":"text","code":"Access denied"}]}},"version":"5783990d5cbce30e0074e145","isReference":true,"slug":"retrieve-an-integration","childrenPages":[]}

getRetrieve an integration

Retrieves the details of an existing integration. Supply the unique integration key (ID) and Slemma will return the corresponding integration information.

Path Params

key:
required
integer
The identifier of the integration to be retrieved.
## RETURNS Returns an Integration object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-1": "An integration object", "0-0": "200 OK", "0-2": "An integration has been retrieved successfully.", "2-0": "403 Forbidden", "2-1": "Access denied", "2-2": "Access to the integration is denied.", "3-0": "404 Not Found", "3-1": "Object not found", "3-2": "An integration with the specified key wasn't found.", "1-0": "400 Bad Request", "1-1": "Parameter is empty", "1-2": "The parameter \"key\" cannot be empty." }, "cols": 3, "rows": 4 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## RETURNS Returns an Integration object if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-1": "An integration object", "0-0": "200 OK", "0-2": "An integration has been retrieved successfully.", "2-0": "403 Forbidden", "2-1": "Access denied", "2-2": "Access to the integration is denied.", "3-0": "404 Not Found", "3-1": "Object not found", "3-2": "An integration with the specified key wasn't found.", "1-0": "400 Bad Request", "1-1": "Parameter is empty", "1-2": "The parameter \"key\" cannot be empty." }, "cols": 3, "rows": 4 } [/block]
{"_id":"57d8f6f73916800e003dde65","category":"5787939b5286030e00589c12","createdAt":"2016-09-14T07:06:31.533Z","excerpt":"","order":0,"project":"5783990d5cbce30e0074e144","sync_unique":"","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]}},"body":"The API currently supports only creation Datasets based on integrations to databases. Datasets can be created based on a SQL query or the entire table from your DB. You can retrieve and create a dataset. To delete the dataset, you have to call [Objects](doc:delete-an-object) endpoint. Datasets are identified by an unique ID.","type":"basic","parentDoc":null,"title":"Datasets","version":"5783990d5cbce30e0074e145","hidden":false,"link_url":"","user":"5492aa57f0d1810b0066005f","link_external":false,"isReference":true,"slug":"datasets","updates":[],"__v":0,"githubsync":"","childrenPages":[]}

Datasets


The API currently supports only creation Datasets based on integrations to databases. Datasets can be created based on a SQL query or the entire table from your DB. You can retrieve and create a dataset. To delete the dataset, you have to call [Objects](doc:delete-an-object) endpoint. Datasets are identified by an unique ID.
The API currently supports only creation Datasets based on integrations to databases. Datasets can be created based on a SQL query or the entire table from your DB. You can retrieve and create a dataset. To delete the dataset, you have to call [Objects](doc:delete-an-object) endpoint. Datasets are identified by an unique ID.
{"_id":"57c559ac446d4b0e006fa0d8","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"createdAt":"2016-08-30T10:02:20.659Z","order":1,"parentDoc":null,"project":"5783990d5cbce30e0074e144","title":"The dataset object","type":"basic","user":"5492aa57f0d1810b0066005f","excerpt":"","hidden":false,"version":"5783990d5cbce30e0074e145","__v":1,"category":"5787939b5286030e00589c12","isReference":true,"link_external":false,"slug":"the-dataset-object","sync_unique":"","updates":[],"body":"A Dataset contains the following fields: \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Key\",\n    \"2-0\": \"Owner\",\n    \"1-0\": \"Name\",\n    \"0-1\": \"Integer\",\n    \"1-1\": \"String\",\n    \"2-1\": \"Integer\",\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"The Slemma defined id representing the dataset.\",\n    \"1-2\": \"Name of the Dataset.\",\n    \"2-2\": \"The Slemma defined id representing the user, who created the Dataset\",\n    \"9-0\": \"FullTableName\",\n    \"10-0\": \"SharedWith\",\n    \"11-0\": \"*GroupsAccess*\",\n    \"9-1\": \"String\",\n    \"10-1\": \"Array of Objects\",\n    \"11-1\": \"Array of Integer\",\n    \"5-0\": \"[ExtType](doc:exttype)\",\n    \"5-1\": \"String\",\n    \"4-0\": \"Type\",\n    \"4-1\": \"String\",\n    \"4-2\": \"The type of the Object. **Value is 'Dataset'.**\",\n    \"5-2\": \"An additional attribute to describe Datasets, Integrations and Reports. The possible values are listed [here](doc:exttype).\",\n    \"9-2\": \"The name of the table the Dataset is build on.\",\n    \"10-2\": \"An array containing Users or Groups who has access to that dataset, with the options described below.\",\n    \"11-2\": \"Array of Group identifiers, each with specified permissions on the object.\",\n    \"12-0\": \"*UsersAccess*\",\n    \"12-1\": \"Array of Integer\",\n    \"12-2\": \"Array of User identifiers, each with specified permissions on the object.\",\n    \"13-0\": \"AccessOfTeam\",\n    \"13-1\": \"Boolean\",\n    \"13-2\": \"Default permissions on the object applied to all team users that the object belongs to.\",\n    \"7-0\": \"SQL\",\n    \"8-0\": \"IntegrationKey\",\n    \"8-1\": \"Integer\",\n    \"7-1\": \"String\",\n    \"7-2\": \"A string that contains the SQL query the dataset is build on.\",\n    \"8-2\": \"The Slemma defined id representing the Integration associated with the Dataset.\",\n    \"6-0\": \"[SourceType](doc:sourcetype)\",\n    \"6-1\": \"String\",\n    \"6-2\": \"The type of the Dataset. SourceType for Datasets is determined by SourceType of the matching Integration. Possible values are listed [here](doc:sourcetype).\",\n    \"3-0\": \"Parent\",\n    \"3-1\": \"Integer\",\n    \"3-2\": \"The Slemma defined id representing the folder the Dataset belongs to.\"\n  },\n  \"cols\": 3,\n  \"rows\": 14\n}\n[/block]","link_url":"","next":{"description":"","pages":[]},"githubsync":"","childrenPages":[]}

The dataset object


A Dataset contains the following fields: [block:parameters] { "data": { "0-0": "Key", "2-0": "Owner", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the dataset.", "1-2": "Name of the Dataset.", "2-2": "The Slemma defined id representing the user, who created the Dataset", "9-0": "FullTableName", "10-0": "SharedWith", "11-0": "*GroupsAccess*", "9-1": "String", "10-1": "Array of Objects", "11-1": "Array of Integer", "5-0": "[ExtType](doc:exttype)", "5-1": "String", "4-0": "Type", "4-1": "String", "4-2": "The type of the Object. **Value is 'Dataset'.**", "5-2": "An additional attribute to describe Datasets, Integrations and Reports. The possible values are listed [here](doc:exttype).", "9-2": "The name of the table the Dataset is build on.", "10-2": "An array containing Users or Groups who has access to that dataset, with the options described below.", "11-2": "Array of Group identifiers, each with specified permissions on the object.", "12-0": "*UsersAccess*", "12-1": "Array of Integer", "12-2": "Array of User identifiers, each with specified permissions on the object.", "13-0": "AccessOfTeam", "13-1": "Boolean", "13-2": "Default permissions on the object applied to all team users that the object belongs to.", "7-0": "SQL", "8-0": "IntegrationKey", "8-1": "Integer", "7-1": "String", "7-2": "A string that contains the SQL query the dataset is build on.", "8-2": "The Slemma defined id representing the Integration associated with the Dataset.", "6-0": "[SourceType](doc:sourcetype)", "6-1": "String", "6-2": "The type of the Dataset. SourceType for Datasets is determined by SourceType of the matching Integration. Possible values are listed [here](doc:sourcetype).", "3-0": "Parent", "3-1": "Integer", "3-2": "The Slemma defined id representing the folder the Dataset belongs to." }, "cols": 3, "rows": 14 } [/block]
A Dataset contains the following fields: [block:parameters] { "data": { "0-0": "Key", "2-0": "Owner", "1-0": "Name", "0-1": "Integer", "1-1": "String", "2-1": "Integer", "h-0": "Attribute", "h-1": "Type", "h-2": "Description", "0-2": "The Slemma defined id representing the dataset.", "1-2": "Name of the Dataset.", "2-2": "The Slemma defined id representing the user, who created the Dataset", "9-0": "FullTableName", "10-0": "SharedWith", "11-0": "*GroupsAccess*", "9-1": "String", "10-1": "Array of Objects", "11-1": "Array of Integer", "5-0": "[ExtType](doc:exttype)", "5-1": "String", "4-0": "Type", "4-1": "String", "4-2": "The type of the Object. **Value is 'Dataset'.**", "5-2": "An additional attribute to describe Datasets, Integrations and Reports. The possible values are listed [here](doc:exttype).", "9-2": "The name of the table the Dataset is build on.", "10-2": "An array containing Users or Groups who has access to that dataset, with the options described below.", "11-2": "Array of Group identifiers, each with specified permissions on the object.", "12-0": "*UsersAccess*", "12-1": "Array of Integer", "12-2": "Array of User identifiers, each with specified permissions on the object.", "13-0": "AccessOfTeam", "13-1": "Boolean", "13-2": "Default permissions on the object applied to all team users that the object belongs to.", "7-0": "SQL", "8-0": "IntegrationKey", "8-1": "Integer", "7-1": "String", "7-2": "A string that contains the SQL query the dataset is build on.", "8-2": "The Slemma defined id representing the Integration associated with the Dataset.", "6-0": "[SourceType](doc:sourcetype)", "6-1": "String", "6-2": "The type of the Dataset. SourceType for Datasets is determined by SourceType of the matching Integration. Possible values are listed [here](doc:sourcetype).", "3-0": "Parent", "3-1": "Integer", "3-2": "The Slemma defined id representing the folder the Dataset belongs to." }, "cols": 3, "rows": 14 } [/block]
{"_id":"57c559be89df2b1700ed989f","updates":[],"body":"## Returns\nReturns a new Dataset object if the call succeeded.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"A dataset object\",\n    \"0-2\": \"A dataset has been created successfully.\",\n    \"0-0\": \"200 OK\",\n    \"1-1\": \"Property 'IntegrationKey' cannot be empty\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-1\": \"Properties 'SQL' and 'FullTableName' are empty\",\n    \"2-0\": \"400 Bad Request\",\n    \"1-2\": \"The field \\\"IntegrationKey\\\" cannot be empty.\",\n    \"2-2\": \"The fields \\\"FullTableName\\\", \\\"SQL\\\" cannot be empty.\",\n    \"3-0\": \"400 Bad Request\",\n    \"3-2\": \"The SQL query that was specified is incorrect.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","createdAt":"2016-08-30T10:02:38.192Z","next":{"description":"","pages":[]},"link_url":"","order":2,"parentDoc":null,"project":"5783990d5cbce30e0074e144","api":{"examples":{"codes":[{"code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\":\"DatasetMySQL\", \"SQL\" : \"SELECT * FROM Table\", \"IntegrationKey\" : 183380}\nhttps://slemma.com/api/v1/datasets","language":"curl"}]},"method":"put","params":[{"_id":"57c54beffc81340e00ebf584","ref":"","in":"body","required":true,"desc":"Name of the Dataset","default":"","type":"string","name":"Name"},{"_id":"57878e1c5286030e00589bf5","ref":"","in":"body","required":true,"desc":"The Slemma defined id representing the Integration associated with the Dataset.","default":"","type":"int","name":"IntegrationKey"},{"_id":"57d6524e8bd2f30e004aea87","ref":"","in":"body","required":false,"desc":"The ID of an existing folder to add this Dataset to. If nothing is passed, then the Dataset will be created in a root folder.","default":"","type":"int","name":"Parent"},{"_id":"57c67cd57e0b250e000d656d","ref":"","in":"body","required":false,"desc":"A string that contains the SQL query the dataset will be build on.","default":"","type":"string","name":"SQL"},{"_id":"57c67cd57e0b250e000d656c","ref":"","in":"body","required":false,"desc":"The name of the table (from DB) the Dataset will be build on.","default":"","type":"string","name":"FullTableName"}],"results":{"codes":[{"name":"","code":"{\n   \"Key\": 186899,\n   \"Name\": \"DatasetMySQL\",\n   \"Type\": \"Dataset\",\n   \"ExtType\": \"MySQL\",\n   \"Owner\": 37168,\n   \"SharedWith\":{\n     \"GroupsAccess\": {},\n     \"UsersAccess\": {}\n   \t},\n   \"Parent\": 179735,\n   \"SourceType\": \"Flat\",\n   \"SQL\": \"SELECT * FROM Table\",\n   \"IntegrationKey\": 183380\n}","language":"json","status":200},{"status":400,"name":"","code":"Depending on the errors:\n1. Property 'IntegrationKey' cannot be empty\n2. Incorrect SourceType for this integration\n3. Properties 'SQL' and 'FullTableName' are empty\n4. Syntax errors in the query","language":"text"}]},"settings":"","url":"/datasets","auth":"required"},"category":"5787939b5286030e00589c12","excerpt":"Creates a new Dataset object based on SQL query.","link_external":false,"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","title":"Create a dataset on SQL query","type":"put","githubsync":"","hidden":false,"slug":"create-a-dataset","sync_unique":"","__v":6,"isReference":true,"childrenPages":[]}

putCreate a dataset on SQL query

Creates a new Dataset object based on SQL query.

Body Params

Name:
required
string
Name of the Dataset
IntegrationKey:
required
integer
The Slemma defined id representing the Integration associated with the Dataset.
Parent:
integer
The ID of an existing folder to add this Dataset to. If nothing is passed, then the Dataset will be created in a root folder.
SQL:
string
A string that contains the SQL query the dataset will be build on.
FullTableName:
string
The name of the table (from DB) the Dataset will be build on.
## Returns Returns a new Dataset object if the call succeeded. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-1": "A dataset object", "0-2": "A dataset has been created successfully.", "0-0": "200 OK", "1-1": "Property 'IntegrationKey' cannot be empty", "1-0": "400 Bad Request", "2-1": "Properties 'SQL' and 'FullTableName' are empty", "2-0": "400 Bad Request", "1-2": "The field \"IntegrationKey\" cannot be empty.", "2-2": "The fields \"FullTableName\", \"SQL\" cannot be empty.", "3-0": "400 Bad Request", "3-2": "The SQL query that was specified is incorrect." }, "cols": 3, "rows": 4 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns a new Dataset object if the call succeeded. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-1": "A dataset object", "0-2": "A dataset has been created successfully.", "0-0": "200 OK", "1-1": "Property 'IntegrationKey' cannot be empty", "1-0": "400 Bad Request", "2-1": "Properties 'SQL' and 'FullTableName' are empty", "2-0": "400 Bad Request", "1-2": "The field \"IntegrationKey\" cannot be empty.", "2-2": "The fields \"FullTableName\", \"SQL\" cannot be empty.", "3-0": "400 Bad Request", "3-2": "The SQL query that was specified is incorrect." }, "cols": 3, "rows": 4 } [/block]
{"_id":"5a28e585ec2b8400128ecc67","project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","category":"5787939b5286030e00589c12","user":"578f1ec8a2ca94200046162a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-12-07T06:53:57.564Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"{\n   \"Key\": 186899,\n   \"Name\": \"MyCustomDataset\",\n   \"Type\": \"Dataset\",\n   \"ExtType\": \"Custom\",\n   \"Owner\": 37168,\n   \"SharedWith\":{\n     \"GroupsAccess\": {},\n     \"UsersAccess\": {}\n   \t},\n   \"Parent\": 179735,\n   \"SourceType\": \"Flat\",\n   \"Fields\": [{\n\t\t\t\"Name\": \"Field 0\",\n\t\t\t\"Type\": \"Measure\"\n\t\t},\n\t\t{\n\t\t\t\"Name\": \"Field 1\",\n\t\t\t\"Type\": \"Dimension\"\n\t\t},\n\t\t{\n\t\t\t\"Name\": \"Field 2\",\n\t\t\t\"Type\": \"Calendar\"\n\t\t}]\n}","language":"json","status":200},{"status":400,"name":"","code":"","language":"text"}]},"method":"put","examples":{"codes":[{"code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Name\":\"MyCustomDataset\", \"Type\" : \"Custom\", \"Fields\" : [{\"Name\": \"Field 0\",\"Type\": \"Measure\"},{\"Name\": \"Field 1\",\"Type\": \"Dimension\"},{\"Name\": \"Field 2\",\"Type\": \"Calendar\"}]}\nhttps://slemma.com/api/v1/datasets","language":"curl"}]},"auth":"required","params":[{"_id":"57c54beffc81340e00ebf584","ref":"","in":"body","required":true,"desc":"Name of the Dataset","default":"","type":"string","name":"Name"},{"_id":"57878e1c5286030e00589bf5","ref":"","in":"body","required":true,"desc":"Type of Dataset should be 'Custom'","default":"","type":"string","name":"Type"},{"_id":"5a28e585ec2b8400128ecc68","ref":"","in":"body","required":true,"desc":"The list of fields {\"Name\":\"FieldName\",\"Type\":\"FieldType\"}","default":"","type":"array_mixed","name":"Fields"},{"_id":"57d6524e8bd2f30e004aea87","ref":"","in":"body","required":false,"desc":"The ID of an existing folder to add this Dataset to. If nothing is passed, then the Dataset will be created in a root folder.","default":"","type":"int","name":"Parent"}],"url":"/datasets"},"isReference":true,"order":3,"body":"## Returns\nReturns a new Dataset object if the call succeeded.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"A dataset object\",\n    \"0-2\": \"A dataset has been created successfully.\",\n    \"0-0\": \"200 OK\",\n    \"1-1\": \"\",\n    \"1-0\": \"400 Bad Request\",\n    \"1-2\": \"\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]","excerpt":"Creates a new custom Dataset object.","slug":"create-a-custom-dataset","type":"put","title":"Create a custom dataset","__v":1,"parentDoc":null,"childrenPages":[]}

putCreate a custom dataset

Creates a new custom Dataset object.

Body Params

Name:
required
string
Name of the Dataset
Type:
required
string
Type of Dataset should be 'Custom'
Fields:
required
array of mixed
The list of fields {"Name":"FieldName","Type":"FieldType"}
Parent:
integer
The ID of an existing folder to add this Dataset to. If nothing is passed, then the Dataset will be created in a root folder.
## Returns Returns a new Dataset object if the call succeeded. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-1": "A dataset object", "0-2": "A dataset has been created successfully.", "0-0": "200 OK", "1-1": "", "1-0": "400 Bad Request", "1-2": "" }, "cols": 3, "rows": 2 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## Returns Returns a new Dataset object if the call succeeded. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-1": "A dataset object", "0-2": "A dataset has been created successfully.", "0-0": "200 OK", "1-1": "", "1-0": "400 Bad Request", "1-2": "" }, "cols": 3, "rows": 2 } [/block]
{"_id":"57c56607eebbdc1700089a22","__v":1,"createdAt":"2016-08-30T10:55:03.115Z","user":"5492aa57f0d1810b0066005f","title":"Retrieve a dataset","version":"5783990d5cbce30e0074e145","body":"## RETURNS\nReturns an Dataset if a valid identifier was provided.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Rescponse content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"A dataset has been retrieved successfully.\",\n    \"0-1\": \"A dataset object\",\n    \"1-0\": \"400 Bad Request\",\n    \"1-1\": \"Parameter is empty\",\n    \"1-2\": \"The parameter \\\"key\\\" cannot be empty.\",\n    \"2-0\": \"404 Not Found\",\n    \"2-1\": \"Object not found\",\n    \"2-2\": \"A dataset with the specified key wasn't found.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","githubsync":"","link_url":"","order":4,"parentDoc":null,"link_external":false,"slug":"retrieve-a-dataset","updates":[],"category":"5787939b5286030e00589c12","excerpt":"Retrieves the details of an existing dataset. Supply the unique daatset key (ID) and Slemma will return the corresponding dataset information.","hidden":false,"isReference":true,"api":{"params":[{"default":"","desc":"The identifier of the dataset to be retrieved.","in":"path","name":"key","ref":"","required":true,"type":"int","_id":"55767c611ce9e637005014e1"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n   \"Key\": 1607,\n   \"Name\": \"DatasetMySQL\",\n   \"Type\": \"Dataset\",\n   \"ExtType\": \"MySQL\",\n   \"Owner\": 37168,\n   \"SharedWith\":{\n     \"GroupsAccess\": {\n        \"849\": \"Edit\"},\n     \"UsersAccess\": {\n        \"36757\": \"EditWithAccessEdit\"}\n   \t},\n   \"AccessOfTeam\": \"Edit\",\n   \"Parent\": 179735,\n   \"SourceType\": \"Flat\",\n   \"SQL\": \"SELECT * FROM Table\",\n   \"IntegrationKey\": 183380\n}","name":""},{"code":"Parameter is empty","name":"","status":400,"language":"text"},{"status":404,"language":"text","code":"Object not found"}]},"settings":"","url":"/datasets/:key","auth":"required","examples":{"codes":[{"code":"cURL -i -X GET \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/datasets/1607","language":"curl"}]},"method":"get"},"next":{"description":"","pages":[]},"project":"5783990d5cbce30e0074e144","sync_unique":"","type":"get","childrenPages":[]}

getRetrieve a dataset

Retrieves the details of an existing dataset. Supply the unique daatset key (ID) and Slemma will return the corresponding dataset information.

Path Params

key:
required
integer
The identifier of the dataset to be retrieved.
## RETURNS Returns an Dataset if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Rescponse content", "h-2": "Description", "0-0": "200 OK", "0-2": "A dataset has been retrieved successfully.", "0-1": "A dataset object", "1-0": "400 Bad Request", "1-1": "Parameter is empty", "1-2": "The parameter \"key\" cannot be empty.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "A dataset with the specified key wasn't found." }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



## RETURNS Returns an Dataset if a valid identifier was provided. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Rescponse content", "h-2": "Description", "0-0": "200 OK", "0-2": "A dataset has been retrieved successfully.", "0-1": "A dataset object", "1-0": "400 Bad Request", "1-1": "Parameter is empty", "1-2": "The parameter \"key\" cannot be empty.", "2-0": "404 Not Found", "2-1": "Object not found", "2-2": "A dataset with the specified key wasn't found." }, "cols": 3, "rows": 3 } [/block]
{"_id":"578c7ba124bd110e0079dfd9","excerpt":"","slug":"publishing-objects","updates":[],"title":"Publishing Objects","body":"You can can grant access for Team members and Clients for any number of Objects. Each user's [permissions](https://dash.readme.io/project/slemma/v1/docs/permissions) are defined by their [role](https://dash.readme.io/project/slemma/v1/docs/teamrole). No one on the team or clients can view or edit Objects unless you share them (aka grant access).\nYou can share Objects with the entire team, groups of users/clients or individual users. Learn more [here](http://support.slemma.com/knowledge_base/topics/access-management). Dashboards and reports can also be shared via a direct public link.\n\nCurrently Slemma's API allows to grant and revoke access.","category":"57873d0faff9b81900afc650","githubsync":"","isReference":true,"link_url":"","order":0,"project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","__v":2,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"createdAt":"2016-07-18T06:48:01.406Z","hidden":false,"parentDoc":null,"type":"basic","link_external":false,"next":{"pages":[],"description":""},"sync_unique":"","user":"5492aa57f0d1810b0066005f","childrenPages":[]}

Publishing Objects


You can can grant access for Team members and Clients for any number of Objects. Each user's [permissions](https://dash.readme.io/project/slemma/v1/docs/permissions) are defined by their [role](https://dash.readme.io/project/slemma/v1/docs/teamrole). No one on the team or clients can view or edit Objects unless you share them (aka grant access). You can share Objects with the entire team, groups of users/clients or individual users. Learn more [here](http://support.slemma.com/knowledge_base/topics/access-management). Dashboards and reports can also be shared via a direct public link. Currently Slemma's API allows to grant and revoke access.
You can can grant access for Team members and Clients for any number of Objects. Each user's [permissions](https://dash.readme.io/project/slemma/v1/docs/permissions) are defined by their [role](https://dash.readme.io/project/slemma/v1/docs/teamrole). No one on the team or clients can view or edit Objects unless you share them (aka grant access). You can share Objects with the entire team, groups of users/clients or individual users. Learn more [here](http://support.slemma.com/knowledge_base/topics/access-management). Dashboards and reports can also be shared via a direct public link. Currently Slemma's API allows to grant and revoke access.
{"_id":"5912d349f477c8390088fe64","createdAt":"2017-05-10T08:46:01.008Z","user":"5492aa57f0d1810b0066005f","api":{"settings":"","url":"/access/:object_key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X PUT\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"Message\": \"Example Message\",\n     \t \"AccessOfTeam\": \"Edit\",\n\t\t\t \"GroupsAccess\": {\n        \t\"849\": \"Edit\"},\n    \t \"UsersAccess\": {\n        \"36757\": \"EditWithAccessEdit\"}\n\t\t\t}\n\n   https://slemma.com/api/v1/access/169413"}]},"method":"put","params":[{"_id":"578763e7b2f4060e00fa3bda","ref":"","in":"path","required":true,"desc":"The Slemma defined ID representing the object to be shared. It could be a dataset, a dashboard, a report, an integration or folder.","default":"","type":"int","name":"object_key"},{"name":"GroupsAccess","_id":"578777c81a34b50e005a9e41","ref":"","in":"body","required":false,"desc":"An array of group(s) identifiers, each with specified permissions you'd like the object to be shared to. To <b>update</b> access permissions pass only <b>new</b> identifiers to <code>Groups</code> to include new group(s). Otherwise use DELETE method to revoke access for a group(s).","default":"","type":"object"},{"type":"object","name":"UsersAccess","_id":"57b2ad098a92cc1700e153f5","ref":"","in":"body","required":false,"desc":"An array of user(s) identifiers, each with specified permissions you'd like the object to be shared with. To <b>update</b> access permissions pass only <b>new</b> identifiers to <code>Users</code> to include new users. Otherwise use DELETE method to revoke access for a user(s).","default":""},{"desc":"Default permissions on the object applied to all users on the team","default":"","type":"string","name":"AccessOfTeam","_id":"57b2ad098a92cc1700e153f3","ref":"","in":"body","required":false},{"_id":"57b2ad098a92cc1700e153f4","ref":"","in":"body","required":false,"desc":"You may optionally send a custom message to users to notify them that the Object has been shared with them. You have to provide the message here.","default":"","type":"string","name":"Message"}],"results":{"codes":[{"name":"","code":"","language":"json","status":200},{"name":"","code":"Depending on the errors:\n1. Can't delete access from owner of team\n2. Can't delete access from owner object\n3. You can't share non team infographics.\n4. Invalid access value \n5. Blocked access is not supported for Team ","language":"text","status":400},{"code":"Access denied","language":"text","status":403},{"code":"Object not found","language":"text","status":404}]}},"category":"57873d0faff9b81900afc650","link_url":"","order":1,"parentDoc":null,"project":"5783990d5cbce30e0074e144","title":"Grant Access","type":"put","body":"Descriptions of available object Permissions are listed [here](doc:permissions)\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"1-1\": \"Can't delete access from the owner of team\",\n    \"2-1\": \"Can't delete access from owner object\",\n    \"3-1\": \"You can't share non team objects.\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"1-2\": \"You can't change access permissions for the user with 'Owner' role if you are making requests on behalf of the 'Owner'.\",\n    \"7-0\": \"404 Not Found\",\n    \"7-1\": \"Object not found\",\n    \"7-2\": \"The group or user ID that was specified doesn't exists.\",\n    \"0-0\": \"200 OK\",\n    \"3-2\": \"The object key that was specified does not belong to your team.\",\n    \"0-2\": \"The access to the object was granted successfully.\",\n    \"4-0\": \"400 Bad Request\",\n    \"4-1\": \"Invalid access value\",\n    \"4-2\": \"The [permission](https://slemma.readme.io/docs/permissions) that was specified is invalid.\",\n    \"6-0\": \"403 Forbidden\",\n    \"6-1\": \"Access denied\",\n    \"6-2\": \"Access to the object is denied.\",\n    \"2-2\": \"You can't change access permissions for the user if you are making requests on behalf of this user\",\n    \"5-0\": \"400 Bad Request\",\n    \"5-1\": \"Blocked access is not supported for Team\",\n    \"5-2\": \"'Blocked' [Permission](doc:permissions) couldn't be  specified for the 'AccessOfTeam' parameter.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","hidden":false,"link_external":false,"next":{"description":"","pages":[]},"updates":[],"githubsync":"","isReference":true,"excerpt":"Grants access for team, groups and/or individual users.","slug":"grant-access","sync_unique":"","version":"5783990d5cbce30e0074e145","__v":0,"childrenPages":[]}

putGrant Access

Grants access for team, groups and/or individual users.

Path Params

object_key:
required
integer
The Slemma defined ID representing the object to be shared. It could be a dataset, a dashboard, a report, an integration or folder.

Body Params

GroupsAccess:
object
An array of group(s) identifiers, each with specified permissions you'd like the object to be shared to. To <b>update</b> access permissions pass only <b>new</b> identifiers to <code>Groups</code> to include new group(s). Otherwise use DELETE method to revoke access for a group(s).
UsersAccess:
object
An array of user(s) identifiers, each with specified permissions you'd like the object to be shared with. To <b>update</b> access permissions pass only <b>new</b> identifiers to <code>Users</code> to include new users. Otherwise use DELETE method to revoke access for a user(s).
AccessOfTeam:
string
Default permissions on the object applied to all users on the team
Message:
string
You may optionally send a custom message to users to notify them that the Object has been shared with them. You have to provide the message here.
Descriptions of available object Permissions are listed [here](doc:permissions) The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "1-1": "Can't delete access from the owner of team", "2-1": "Can't delete access from owner object", "3-1": "You can't share non team objects.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "1-2": "You can't change access permissions for the user with 'Owner' role if you are making requests on behalf of the 'Owner'.", "7-0": "404 Not Found", "7-1": "Object not found", "7-2": "The group or user ID that was specified doesn't exists.", "0-0": "200 OK", "3-2": "The object key that was specified does not belong to your team.", "0-2": "The access to the object was granted successfully.", "4-0": "400 Bad Request", "4-1": "Invalid access value", "4-2": "The [permission](https://slemma.readme.io/docs/permissions) that was specified is invalid.", "6-0": "403 Forbidden", "6-1": "Access denied", "6-2": "Access to the object is denied.", "2-2": "You can't change access permissions for the user if you are making requests on behalf of this user", "5-0": "400 Bad Request", "5-1": "Blocked access is not supported for Team", "5-2": "'Blocked' [Permission](doc:permissions) couldn't be specified for the 'AccessOfTeam' parameter." }, "cols": 3, "rows": 8 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



Descriptions of available object Permissions are listed [here](doc:permissions) The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "1-1": "Can't delete access from the owner of team", "2-1": "Can't delete access from owner object", "3-1": "You can't share non team objects.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "1-2": "You can't change access permissions for the user with 'Owner' role if you are making requests on behalf of the 'Owner'.", "7-0": "404 Not Found", "7-1": "Object not found", "7-2": "The group or user ID that was specified doesn't exists.", "0-0": "200 OK", "3-2": "The object key that was specified does not belong to your team.", "0-2": "The access to the object was granted successfully.", "4-0": "400 Bad Request", "4-1": "Invalid access value", "4-2": "The [permission](https://slemma.readme.io/docs/permissions) that was specified is invalid.", "6-0": "403 Forbidden", "6-1": "Access denied", "6-2": "Access to the object is denied.", "2-2": "You can't change access permissions for the user if you are making requests on behalf of this user", "5-0": "400 Bad Request", "5-1": "Blocked access is not supported for Team", "5-2": "'Blocked' [Permission](doc:permissions) couldn't be specified for the 'AccessOfTeam' parameter." }, "cols": 3, "rows": 8 } [/block]
{"_id":"5912db0fc188f10f00502de6","githubsync":"","isReference":true,"type":"delete","sync_unique":"","user":"5492aa57f0d1810b0066005f","api":{"url":"/access/:object_key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d {\"AccessOfTeam\": null,\n\t\t\t \"GroupsAccess\": {\n        \t\"849\": null},\n    \t \"UsersAccess\": {\n        \"36757\": null}\n\t\t\t}\n   https://slemma.com/api/v1/access/169413"}]},"method":"delete","params":[{"ref":"","in":"path","required":true,"desc":"The identifier of the object to revoke access to.","default":"","type":"int","name":"object_key","_id":"578763e7b2f4060e00fa3bda"},{"default":"","type":"object","name":"GroupsAccess","_id":"578ef59f63061c2b00be95a8","ref":"","in":"body","required":false,"desc":"An array of group(s) identifiers you'd like to revoke access, each with 'Null' permission specified."},{"in":"body","required":false,"desc":"An array of user(s) identifiers you'd like to revoke access, each with 'Null' permission specified.","default":"","type":"object","name":"UsersAccess","_id":"57b2b64ac9a4551700b96829","ref":""},{"desc":"To deny team' access to the object specify 'Null'.","default":"","type":"object","name":"AccessOfTeam","_id":"584a708f09124c0f004c15d4","ref":"","in":"body","required":false}],"results":{"codes":[{"name":"","code":"","language":"text","status":200},{"code":"Depending on the errors:\n1. Can't delete access from owner of team\n2. Can't delete access from owner object\n3. You can't share non team infographics.\n4. Invalid access value \n5. Blocked access is not supported for Team ","language":"text","status":400,"name":""},{"status":403,"language":"text","code":"Access denied"},{"status":404,"language":"text","code":"Object not found"}]},"settings":""},"excerpt":"Revokes access to dashboard or report for the defined users, group(s) and team.","next":{"pages":[],"description":""},"order":2,"version":"5783990d5cbce30e0074e145","category":"57873d0faff9b81900afc650","slug":"revoke-access","title":"Revoke Access","link_external":false,"link_url":"","parentDoc":null,"project":"5783990d5cbce30e0074e144","__v":0,"body":"If none of the optional parameters are passed in the request, then all users and groups will lose access to the Object, including access via the direct link.\n\nThe following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-2\": \"The access to the object was revoked successfully.\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"4-0\": \"400 Bad Request\",\n    \"5-0\": \"400 Bad Request\",\n    \"6-0\": \"403 Forbidden\",\n    \"1-1\": \"Can't delete access from owner of team\",\n    \"2-1\": \"Can't delete access from owner object\",\n    \"3-1\": \"You can't share non team infographics.\",\n    \"4-1\": \"Invalid access value\",\n    \"5-1\": \"Blocked access is not supported for Team\",\n    \"7-0\": \"404 Not Found\",\n    \"1-2\": \"If you're trying to change access to an object, whose owner you are not and you are  owner of this team.\",\n    \"2-2\": \"If you're trying to change access to an object, whose owner you are and you are not owner of this team.\",\n    \"3-2\": \"The object key that was specified does not belong to your team.\",\n    \"4-2\": \"The [permission](https://slemma.readme.io/docs/permissions) that was specified is invalid.\",\n    \"5-2\": \"'Blocked' [Permission](doc:permissions) couldn't be  specified for the 'AccessOfTeam' parameter.\",\n    \"6-1\": \"Access denied\",\n    \"7-1\": \"Object not found\",\n    \"6-2\": \"Access to the object is denied.\",\n    \"7-2\": \"The group or user ID that was specified doesn't exists.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","createdAt":"2017-05-10T09:19:11.560Z","hidden":false,"updates":[],"childrenPages":[]}

deleteRevoke Access

Revokes access to dashboard or report for the defined users, group(s) and team.

Path Params

object_key:
required
integer
The identifier of the object to revoke access to.

Body Params

GroupsAccess:
object
An array of group(s) identifiers you'd like to revoke access, each with 'Null' permission specified.
UsersAccess:
object
An array of user(s) identifiers you'd like to revoke access, each with 'Null' permission specified.
AccessOfTeam:
object
To deny team' access to the object specify 'Null'.
If none of the optional parameters are passed in the request, then all users and groups will lose access to the Object, including access via the direct link. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The access to the object was revoked successfully.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "403 Forbidden", "1-1": "Can't delete access from owner of team", "2-1": "Can't delete access from owner object", "3-1": "You can't share non team infographics.", "4-1": "Invalid access value", "5-1": "Blocked access is not supported for Team", "7-0": "404 Not Found", "1-2": "If you're trying to change access to an object, whose owner you are not and you are owner of this team.", "2-2": "If you're trying to change access to an object, whose owner you are and you are not owner of this team.", "3-2": "The object key that was specified does not belong to your team.", "4-2": "The [permission](https://slemma.readme.io/docs/permissions) that was specified is invalid.", "5-2": "'Blocked' [Permission](doc:permissions) couldn't be specified for the 'AccessOfTeam' parameter.", "6-1": "Access denied", "7-1": "Object not found", "6-2": "Access to the object is denied.", "7-2": "The group or user ID that was specified doesn't exists." }, "cols": 3, "rows": 8 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



If none of the optional parameters are passed in the request, then all users and groups will lose access to the Object, including access via the direct link. The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-2": "The access to the object was revoked successfully.", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "4-0": "400 Bad Request", "5-0": "400 Bad Request", "6-0": "403 Forbidden", "1-1": "Can't delete access from owner of team", "2-1": "Can't delete access from owner object", "3-1": "You can't share non team infographics.", "4-1": "Invalid access value", "5-1": "Blocked access is not supported for Team", "7-0": "404 Not Found", "1-2": "If you're trying to change access to an object, whose owner you are not and you are owner of this team.", "2-2": "If you're trying to change access to an object, whose owner you are and you are not owner of this team.", "3-2": "The object key that was specified does not belong to your team.", "4-2": "The [permission](https://slemma.readme.io/docs/permissions) that was specified is invalid.", "5-2": "'Blocked' [Permission](doc:permissions) couldn't be specified for the 'AccessOfTeam' parameter.", "6-1": "Access denied", "7-1": "Object not found", "6-2": "Access to the object is denied.", "7-2": "The group or user ID that was specified doesn't exists." }, "cols": 3, "rows": 8 } [/block]
{"_id":"58c7a76303a5b60f00f2658d","category":"57873d0faff9b81900afc650","hidden":false,"link_external":false,"link_url":"","project":"5783990d5cbce30e0074e144","isReference":true,"order":3,"updates":[],"user":"5492aa57f0d1810b0066005f","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"1-1\": \"Shared link is not enabled for this team\",\n    \"1-0\": \"400 Bad Request\",\n    \"4-0\": \"404 Not Found\",\n    \"4-1\": \"Object not found\",\n    \"4-2\": \"The Object Key that was specified doesn't exists.\",\n    \"0-1\": \"The object with property \\\"ShareUrl\\\"\",\n    \"3-0\": \"403 Forbidden\",\n    \"3-1\": \"Access denied\",\n    \"3-2\": \"Access to the object is denied.\",\n    \"0-2\": \"The shared link has been created successfully.\",\n    \"1-2\": \"To be able to create a shared link you need this option to be enabled for your team. To do so navigate to [\\\"Admin\\\"->\\\"Team Settings\\\"->\\\"Public links\\\"](https://slemma.com/team)\",\n    \"2-1\": \"Email is invalid\",\n    \"2-0\": \"400 Bad Request\",\n    \"2-2\": \"The Email that was specified is invalid.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","type":"put","version":"5783990d5cbce30e0074e145","parentDoc":null,"slug":"grant-access-by-link","__v":0,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X PUT\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/access/link/138998"}]},"method":"put","params":[{"_id":"578763e7b2f4060e00fa3bda","ref":"","in":"path","required":true,"desc":"The Slemma defined ID representing the object to be shared. It could be a dataset, a dashboard, a report, an integration or folder.","default":"","type":"int","name":"object_key"},{"_id":"57878e1c5286030e00589bf5","ref":"","in":"body","required":false,"desc":"Makes the contents of a direct link password protected. You need to pass a password here which is more than 6 characters long.","default":"null","type":"string","name":"Password"},{"name":"Addresses","_id":"57878fb39f5d1b0e00432f7d","ref":"","in":"body","required":false,"desc":"An array of email addresses you'd like to sent a notification when sharing the dashboard/report via the direct URL","default":"","type":"array_string"},{"ref":"","in":"body","required":false,"desc":"You may optionally provide a custom message to include into the email notification.","default":"","type":"string","name":"Message","_id":"57878fb39f5d1b0e00432f7c"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"Key\": 138998\n  \"Name\": \"Global Government Finances by Company\"\n  \"Type\": \"Dashboard\"\n  \"ShareUrl\": \"https://slemma.com/share/54c6bc783*************012f5e00586adc\"\n  \"Owner\": 25283\n  \"SharedWith\": {\n    \"Groups\": [0]\n    \"Users\": [1]\n      0:  25283\n\t}\n  \"ShareToTeam\": false\n}"},{"language":"text","code":"Depending on the errors:\n1. Share url link is not enable for this team\n2. Email is invalid","name":"","status":400},{"code":"Access denied","status":403,"language":"text"},{"code":"Object not found","language":"text","status":404}]},"settings":"","url":"/access/link/:object_key"},"createdAt":"2017-03-14T08:18:43.364Z","excerpt":"Creates a link the dashboard or report can be accessed by. Shared link can be created for Dashboards and Reports only.","githubsync":"","next":{"pages":[],"description":""},"sync_unique":"","title":"Create a Shared Link","childrenPages":[]}

putCreate a Shared Link

Creates a link the dashboard or report can be accessed by. Shared link can be created for Dashboards and Reports only.

Path Params

object_key:
required
integer
The Slemma defined ID representing the object to be shared. It could be a dataset, a dashboard, a report, an integration or folder.

Body Params

Password:
stringnull
Makes the contents of a direct link password protected. You need to pass a password here which is more than 6 characters long.
Addresses:
array of strings
An array of email addresses you'd like to sent a notification when sharing the dashboard/report via the direct URL
Message:
string
You may optionally provide a custom message to include into the email notification.
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "1-1": "Shared link is not enabled for this team", "1-0": "400 Bad Request", "4-0": "404 Not Found", "4-1": "Object not found", "4-2": "The Object Key that was specified doesn't exists.", "0-1": "The object with property \"ShareUrl\"", "3-0": "403 Forbidden", "3-1": "Access denied", "3-2": "Access to the object is denied.", "0-2": "The shared link has been created successfully.", "1-2": "To be able to create a shared link you need this option to be enabled for your team. To do so navigate to [\"Admin\"->\"Team Settings\"->\"Public links\"](https://slemma.com/team)", "2-1": "Email is invalid", "2-0": "400 Bad Request", "2-2": "The Email that was specified is invalid." }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "1-1": "Shared link is not enabled for this team", "1-0": "400 Bad Request", "4-0": "404 Not Found", "4-1": "Object not found", "4-2": "The Object Key that was specified doesn't exists.", "0-1": "The object with property \"ShareUrl\"", "3-0": "403 Forbidden", "3-1": "Access denied", "3-2": "Access to the object is denied.", "0-2": "The shared link has been created successfully.", "1-2": "To be able to create a shared link you need this option to be enabled for your team. To do so navigate to [\"Admin\"->\"Team Settings\"->\"Public links\"](https://slemma.com/team)", "2-1": "Email is invalid", "2-0": "400 Bad Request", "2-2": "The Email that was specified is invalid." }, "cols": 3, "rows": 5 } [/block]
{"_id":"58c7a77dcc38730f00a2c3c6","githubsync":"","next":{"pages":[],"description":""},"order":4,"project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"\",\n    \"0-2\": \"The shared link to the object was disabled successfully.\",\n    \"1-0\": \"403 Forbidden\",\n    \"2-0\": \"404 Not Found\",\n    \"2-2\": \"The Object Key that was specified doesn't exists.\",\n    \"1-2\": \"Access to the object is denied.\",\n    \"2-1\": \"Object not found\",\n    \"1-1\": \"Access denied\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","createdAt":"2017-03-14T08:19:09.495Z","hidden":false,"parentDoc":null,"slug":"revoke-access-link","title":"Revoke a Shared Link","updates":[],"user":"5492aa57f0d1810b0066005f","__v":0,"api":{"results":{"codes":[{"name":null,"code":"","language":"text","status":200},{"name":"","code":"Access denied","language":"text","status":403},{"code":"Object not found","language":"text","status":404}]},"settings":"","url":"/access/link/:object_key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/access/link/138998"}]},"method":"delete","params":[{"_id":"578763e7b2f4060e00fa3bda","ref":"","in":"path","required":true,"desc":"The identifier of the object to revoke access to.","default":"","type":"int","name":"object_key"}]},"sync_unique":"","category":"57873d0faff9b81900afc650","excerpt":"Disables the link to a dashboard or report.","isReference":true,"link_external":false,"link_url":"","type":"delete","childrenPages":[]}

deleteRevoke a Shared Link

Disables the link to a dashboard or report.

Path Params

object_key:
required
integer
The identifier of the object to revoke access to.
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "", "0-2": "The shared link to the object was disabled successfully.", "1-0": "403 Forbidden", "2-0": "404 Not Found", "2-2": "The Object Key that was specified doesn't exists.", "1-2": "Access to the object is denied.", "2-1": "Object not found", "1-1": "Access denied" }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "", "0-2": "The shared link to the object was disabled successfully.", "1-0": "403 Forbidden", "2-0": "404 Not Found", "2-2": "The Object Key that was specified doesn't exists.", "1-2": "Access to the object is denied.", "2-1": "Object not found", "1-1": "Access denied" }, "cols": 3, "rows": 3 } [/block]
{"_id":"59ca318e1382cb001039c22e","project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","category":"57873d0faff9b81900afc650","user":"578f1ec8a2ca94200046162a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-26T10:53:02.312Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"curl","code":"cURL -i -X DELETE\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\nhttps://slemma.com/api/v1/access/link/138998"}]},"settings":"","results":{"codes":[{"name":null,"code":"{\n\t\"Key\": 1111,\n\t\"Name\": \"Assigned chart\",\n\t\"Type\": \"Report\",\n\t\"ExtType\": \"ComboChart\",\n\t\"ShareUrl\": \"https://slemma.com/share/c2076633295251f3af4e9bd50007819f5493e963\",\n\t\"ShareUrlCreator\": 1111,\n\t\"ShareUrlCreateAt\": \"2017-09-25 10:09:15.288+0000\",\n\t\"Owner\": 1111,\n\t\"SharedWith\": {\n\t\t\"GroupsAccess\": {},\n\t\t\"UsersAccess\": {}\n\t}\n}","language":"json","status":200},{"name":"","code":"Share url link is not enable for this team","language":"text","status":400},{"code":"Access denied","language":"text","status":403},{"code":"Object not found","language":"text","status":404},{"code":"Share url link is not allowed for this object","language":"text","status":405}]},"auth":"required","params":[{"_id":"578763e7b2f4060e00fa3bda","ref":"","in":"path","required":true,"desc":"The identifier of the object to retrieve shared link to.","default":"","type":"int","name":"object_key"}],"url":"/access/link/:object_key"},"isReference":true,"order":5,"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"The object with property \\\"ShareUrl\\\"\",\n    \"0-2\": \"The shared link to the object has been retrieved successfully.\",\n    \"2-0\": \"403 Forbidden\",\n    \"3-0\": \"404 Not Found\",\n    \"3-2\": \"The Object Key that was specified doesn't exists.\",\n    \"2-2\": \"Access to the object is denied.\",\n    \"3-1\": \"Object not found\",\n    \"2-1\": \"Access denied\",\n    \"1-0\": \"400 Bad Request\",\n    \"1-2\": \"The option 'Public links' is switched off in Team settings.\",\n    \"4-0\": \"405 Method Not Allowed\",\n    \"4-2\": \"Share url link is not allowed for this object\",\n    \"1-1\": \"Share url link is not enable for this team\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"Get the link to a dashboard or report.","slug":"retrieve-a-shared-link","type":"get","title":"Retrieve a Shared Link","__v":7,"parentDoc":null,"childrenPages":[]}

getRetrieve a Shared Link

Get the link to a dashboard or report.

Path Params

object_key:
required
integer
The identifier of the object to retrieve shared link to.
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "The object with property \"ShareUrl\"", "0-2": "The shared link to the object has been retrieved successfully.", "2-0": "403 Forbidden", "3-0": "404 Not Found", "3-2": "The Object Key that was specified doesn't exists.", "2-2": "Access to the object is denied.", "3-1": "Object not found", "2-1": "Access denied", "1-0": "400 Bad Request", "1-2": "The option 'Public links' is switched off in Team settings.", "4-0": "405 Method Not Allowed", "4-2": "Share url link is not allowed for this object", "1-1": "Share url link is not enable for this team" }, "cols": 3, "rows": 5 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "The object with property \"ShareUrl\"", "0-2": "The shared link to the object has been retrieved successfully.", "2-0": "403 Forbidden", "3-0": "404 Not Found", "3-2": "The Object Key that was specified doesn't exists.", "2-2": "Access to the object is denied.", "3-1": "Object not found", "2-1": "Access denied", "1-0": "400 Bad Request", "1-2": "The option 'Public links' is switched off in Team settings.", "4-0": "405 Method Not Allowed", "4-2": "Share url link is not allowed for this object", "1-1": "Share url link is not enable for this team" }, "cols": 3, "rows": 5 } [/block]
{"_id":"58076376ad246319004d87f6","githubsync":"","body":"Custom Datasets ([Create Custom dataset](http://support.slemma.com/knowledge_base/topics/creating-custom-dataset)) is a simple yet highly flexible way of getting data from almost any data source into Slemma, especially if Slemma doesn't have a native connector to that service or database.\n\nThe API currently supports only pushing data to Custom Datasets and deleting all data. Creation of the Custom Datasets isn't supported by the API and must be done through the [Slemma App](https://slemma.com). Using Slemma UI, you'll need to *add and define fields* for your Custom Dataset. This will let Slemma know what form your data takes.\n\nOnce the Custom Dataset is created you'll get a unique identifier for that dataset. Use this key to push data to the dataset or delete data form the dataset.   \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/5aab995-2016-11-29_13-56-12.jpg\",\n        \"2016-11-29_13-56-12.jpg\",\n        990,\n        392,\n        \"#ededed\"\n      ],\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]","createdAt":"2016-10-19T12:13:42.512Z","isReference":true,"next":{"description":"","pages":[]},"updates":[],"__v":1,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"hidden":false,"link_external":false,"parentDoc":null,"project":"5783990d5cbce30e0074e144","title":"Data operations","type":"basic","category":"5807634c6d47320f007a2f64","excerpt":"Perform tasks related to the custom dataset including importing and deleting the data","version":"5783990d5cbce30e0074e145","slug":"data-operations","sync_unique":"","user":"5492aa57f0d1810b0066005f","link_url":"","order":0,"childrenPages":[]}

Data operations

Perform tasks related to the custom dataset including importing and deleting the data

Custom Datasets ([Create Custom dataset](http://support.slemma.com/knowledge_base/topics/creating-custom-dataset)) is a simple yet highly flexible way of getting data from almost any data source into Slemma, especially if Slemma doesn't have a native connector to that service or database. The API currently supports only pushing data to Custom Datasets and deleting all data. Creation of the Custom Datasets isn't supported by the API and must be done through the [Slemma App](https://slemma.com). Using Slemma UI, you'll need to *add and define fields* for your Custom Dataset. This will let Slemma know what form your data takes. Once the Custom Dataset is created you'll get a unique identifier for that dataset. Use this key to push data to the dataset or delete data form the dataset. [block:image] { "images": [ { "image": [ "https://files.readme.io/5aab995-2016-11-29_13-56-12.jpg", "2016-11-29_13-56-12.jpg", 990, 392, "#ededed" ], "sizing": "full" } ] } [/block]
Custom Datasets ([Create Custom dataset](http://support.slemma.com/knowledge_base/topics/creating-custom-dataset)) is a simple yet highly flexible way of getting data from almost any data source into Slemma, especially if Slemma doesn't have a native connector to that service or database. The API currently supports only pushing data to Custom Datasets and deleting all data. Creation of the Custom Datasets isn't supported by the API and must be done through the [Slemma App](https://slemma.com). Using Slemma UI, you'll need to *add and define fields* for your Custom Dataset. This will let Slemma know what form your data takes. Once the Custom Dataset is created you'll get a unique identifier for that dataset. Use this key to push data to the dataset or delete data form the dataset. [block:image] { "images": [ { "image": [ "https://files.readme.io/5aab995-2016-11-29_13-56-12.jpg", "2016-11-29_13-56-12.jpg", 990, 392, "#ededed" ], "sizing": "full" } ] } [/block]
{"_id":"583bba691eb016230026e4be","title":"Append data to a Custom Dataset","version":"5783990d5cbce30e0074e145","__v":0,"category":"5807634c6d47320f007a2f64","next":{"description":"","pages":[]},"order":1,"parentDoc":null,"excerpt":"Call *PUT* method to **Append** new records (rows) to a dataset by passing an array of objects with key + value representing a record in your dataset.\nIf you need to replace **all** data in your dataset, use *POST* method instead.","githubsync":"","isReference":true,"type":"put","api":{"method":"put","params":[{"in":"path","name":"key","ref":"","required":true,"type":"int","_id":"582974446a1d1f0f00b94485","default":"","desc":"The identifier of the custom dataset"}],"results":{"codes":[{"name":"","code":"{\n    \"RowsAdded\": 3\n}","language":"json","status":200},{"name":"Bad Request","code":"Depending on the errors:\n1. Incorrect value 'example_text_value' of field 'Num of Days'\n2. Field 'Example_Field' not found\n3. Body cannot be empty\n4. Limit exceeded upload rows = 10000","language":"text","status":400},{"status":403,"code":"Access denied","language":"text"},{"code":"Object not found","language":"text","status":404}]},"settings":"58297705702b940f004913d8","url":"/data/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X PUT \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d [ \n       {\"Num of Days\":1,\"Start Date\":\"2016-10-04\",\"First Name\":\"John\",\"Location\":\"LA\"},\n\t\t\t {\"Num of Days\":5,\"Start Date\":\"2016-09-02\",\"First Name\":\"James\",\"Location\":\"CA\"},\n\t\t\t {\"Num of Days\":7,\"Start Date\":\"2016-11-03\",\"First Name\":\"Kelly\",\"Location\":\"CO\"}\n\t  \t]\t\nhttps://slemma.com/api/v1/data/424214"}]}},"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"{\\n    \\\"RowsAdded\\\": 3\\n}\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"1-2\": \"The passed values don’t match the respective field types in the custom dataset, or the date format is incorrect.\",\n    \"2-2\": \"The passed field is not present in the dataset.\",\n    \"6-0\": \"404 Not Found\",\n    \"5-0\": \"403 Forbidden\",\n    \"6-1\": \"Object not found\",\n    \"h-2\": \"Description\",\n    \"0-3\": \"\",\n    \"6-3\": \"\",\n    \"2-1\": \"Field 'Example_Field' not found\",\n    \"1-1\": \"Incorrect value 'example_text_value' of field 'Num of Days'\",\n    \"0-2\": \"Everything worked correctly.\",\n    \"6-2\": \"Dataset not found.\",\n    \"5-1\": \"Access denied\",\n    \"5-2\": \"Access to the dataset is denied.\",\n    \"3-0\": \"400 Bad Request\",\n    \"3-1\": \"Body cannot be empty\",\n    \"4-0\": \"400 Bad Request\",\n    \"4-1\": \"Limit exceeded upload rows = 10000\",\n    \"4-2\": \"The request body contains more than 10000 rows.\",\n    \"3-2\": \"The request body is empty.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"Make sure that the values you are passing match the field types defined in your dataset schema. The number of fields you are passing should also match the number of fields in your dataset schema.\\n\\nIf you only specify a partial set of fields from the custom dataset, the query will still be executed but omitted fields will not be populated with data.\"\n}\n[/block]\n##Rate Limits\n**Records per request**\n\nSlemma supports up to 10000 records per request.","createdAt":"2016-11-28T05:02:33.245Z","project":"5783990d5cbce30e0074e144","sync_unique":"","updates":[],"user":"5492aa57f0d1810b0066005f","hidden":false,"link_external":false,"link_url":"","slug":"append-data-to-a-custom-dataset","childrenPages":[]}

putAppend data to a Custom Dataset

Call *PUT* method to **Append** new records (rows) to a dataset by passing an array of objects with key + value representing a record in your dataset. If you need to replace **all** data in your dataset, use *POST* method instead.

Path Params

key:
required
integer
The identifier of the custom dataset
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "0-0": "200 OK", "0-1": "{\n \"RowsAdded\": 3\n}", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "1-2": "The passed values don’t match the respective field types in the custom dataset, or the date format is incorrect.", "2-2": "The passed field is not present in the dataset.", "6-0": "404 Not Found", "5-0": "403 Forbidden", "6-1": "Object not found", "h-2": "Description", "0-3": "", "6-3": "", "2-1": "Field 'Example_Field' not found", "1-1": "Incorrect value 'example_text_value' of field 'Num of Days'", "0-2": "Everything worked correctly.", "6-2": "Dataset not found.", "5-1": "Access denied", "5-2": "Access to the dataset is denied.", "3-0": "400 Bad Request", "3-1": "Body cannot be empty", "4-0": "400 Bad Request", "4-1": "Limit exceeded upload rows = 10000", "4-2": "The request body contains more than 10000 rows.", "3-2": "The request body is empty." }, "cols": 3, "rows": 7 } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "Make sure that the values you are passing match the field types defined in your dataset schema. The number of fields you are passing should also match the number of fields in your dataset schema.\n\nIf you only specify a partial set of fields from the custom dataset, the query will still be executed but omitted fields will not be populated with data." } [/block] ##Rate Limits **Records per request** Slemma supports up to 10000 records per request.

User Information

Try It Out


put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "0-0": "200 OK", "0-1": "{\n \"RowsAdded\": 3\n}", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "1-2": "The passed values don’t match the respective field types in the custom dataset, or the date format is incorrect.", "2-2": "The passed field is not present in the dataset.", "6-0": "404 Not Found", "5-0": "403 Forbidden", "6-1": "Object not found", "h-2": "Description", "0-3": "", "6-3": "", "2-1": "Field 'Example_Field' not found", "1-1": "Incorrect value 'example_text_value' of field 'Num of Days'", "0-2": "Everything worked correctly.", "6-2": "Dataset not found.", "5-1": "Access denied", "5-2": "Access to the dataset is denied.", "3-0": "400 Bad Request", "3-1": "Body cannot be empty", "4-0": "400 Bad Request", "4-1": "Limit exceeded upload rows = 10000", "4-2": "The request body contains more than 10000 rows.", "3-2": "The request body is empty." }, "cols": 3, "rows": 7 } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "Make sure that the values you are passing match the field types defined in your dataset schema. The number of fields you are passing should also match the number of fields in your dataset schema.\n\nIf you only specify a partial set of fields from the custom dataset, the query will still be executed but omitted fields will not be populated with data." } [/block] ##Rate Limits **Records per request** Slemma supports up to 10000 records per request.
{"_id":"583bc43bd6788f2300513217","slug":"update-records-in-custom-dataset","title":"Update records in custom dataset","updates":[],"version":"5783990d5cbce30e0074e145","link_url":"","order":2,"parentDoc":null,"githubsync":"","link_external":false,"project":"5783990d5cbce30e0074e144","api":{"params":[{"type":"int","name":"key","_id":"583c1684dc05ad0f0078d26c","ref":"","in":"path","required":true,"desc":"The identifier of the custom dataset","default":""}],"results":{"codes":[{"language":"json","code":"{\n    \"RowsUpdated\": 2\n}","name":"","status":200},{"status":400,"language":"text","code":"Depending on the errors:\n1. Field 'Example_Field' not found\n2. Field 'Example_Field' from NewValues not found\n3. Incorrect value '2016-1103 00:00:00.0' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'\n4. You need to set all field values in every passed row\n5. Body cannot be empty\n6. Limit exceeded upload rows = 10000","name":""},{"status":403,"code":"Access denied","language":"text"},{"code":"Object not found","language":"text","status":404}]},"settings":"58297705702b940f004913d8","url":"/data/:key","auth":"required","examples":{"codes":[{"language":"curl","code":"cURL -i -X POST \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d [{\n   \t\t\t\"Row\": {\n\t\t\t\t\t\"Num of Days\": 7,\n\t\t\t\t\t\"Start Date\": \"2016-11-03 00:00:00.0\",\n\t\t\t\t\t\"First Name\": \"Kelly\",\n  \t\t\t\t\"Location\": \"CO\"},\n        \"NewValues\": {\n\t\t\t\t\t\"Num of Days\": 15,\n\t\t\t\t\t\"Start Date\": \"2016-01-01 00:00:00.0\",\n\t\t\t\t\t\"First Name\": \"Brad\",\n      \t\t\"Location\": \"CA\"}\n\t\t\t\t},\n        {\n  \t\t\t\"Row\": {\n\t\t\t\t\t\"Num of Days\": 5,\n\t\t\t\t\t\"Start Date\": \"2016-09-02 00:00:00.0\",\n\t\t\t\t\t\"First Name\": \"James\",\n  \t\t\t\t\"Location\": \"CA\"},\n\t\t\t\t\"NewValues\": {\n\t\t\t\t\t\"Num of Days\": 4,\n\t\t\t\t\t\"Start Date\": \"2016-03-01 00:00:00.0\",\n\t\t\t\t\t\"First Name\": \"Sam\",\n      \t\t\"Location\": \"CA\"}\n \t\t\t}]\nhttps://slemma.com/api/v1/data/424214"}]},"method":"post"},"createdAt":"2016-11-28T05:44:27.005Z","excerpt":"**Update** chosen records (rows) in a dataset by passing an array of pairs (Row and NewValues) of key-value pair objects representing a record in your dataset. As a result, values in the dataset row *fully matching* the Row are replaced with values from NewValues object. You can update multiple records by passing multiple pairs.","category":"5807634c6d47320f007a2f64","isReference":true,"next":{"pages":[],"description":""},"sync_unique":"","type":"post","user":"5492aa57f0d1810b0066005f","__v":1,"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"{\\n    \\\"RowsUpdated\\\": 2\\n}\",\n    \"0-2\": \"Everything worked correctly.\",\n    \"1-0\": \"400 Bad Request\",\n    \"1-1\": \"You need to set all field values in every passed row\",\n    \"2-0\": \"400 Bad Request\",\n    \"3-0\": \"400 Bad Request\",\n    \"2-1\": \"Incorrect value '2016-1103 00:00:00.0' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'\",\n    \"6-0\": \"403 Forbidden\",\n    \"7-0\": \"404 Not Found\",\n    \"7-2\": \"Dataset not found.\",\n    \"3-1\": \"Field 'Example_Field' not found\",\n    \"7-1\": \"Object not found\",\n    \"6-1\": \"Access denied\",\n    \"2-2\": \"If you specify incorrect date format.\",\n    \"3-2\": \"The passed field is not present in the dataset.\",\n    \"6-2\": \"Access to the dataset is denied.\",\n    \"1-2\": \"If you fail to specify one or more field values in the request body.\",\n    \"4-1\": \"Body cannot be empty\",\n    \"4-0\": \"400 Bad Request\",\n    \"5-1\": \"Limit exceeded upload rows = 10000\",\n    \"5-0\": \"400 Bad Request\",\n    \"4-2\": \"The request body is empty.\",\n    \"5-2\": \"The request body contains more than 10000 rows.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"Make sure that the values you are passing match the field types defined for your dataset schema. The number of fields you are passing should also completely match the number of fields in your dataset schema.\"\n}\n[/block]\n##Rate Limits\n**Records per request**\n\nSlemma supports up to 10000 records per request.","hidden":false,"childrenPages":[]}

postUpdate records in custom dataset

**Update** chosen records (rows) in a dataset by passing an array of pairs (Row and NewValues) of key-value pair objects representing a record in your dataset. As a result, values in the dataset row *fully matching* the Row are replaced with values from NewValues object. You can update multiple records by passing multiple pairs.

Path Params

key:
required
integer
The identifier of the custom dataset
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "{\n \"RowsUpdated\": 2\n}", "0-2": "Everything worked correctly.", "1-0": "400 Bad Request", "1-1": "You need to set all field values in every passed row", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "2-1": "Incorrect value '2016-1103 00:00:00.0' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'", "6-0": "403 Forbidden", "7-0": "404 Not Found", "7-2": "Dataset not found.", "3-1": "Field 'Example_Field' not found", "7-1": "Object not found", "6-1": "Access denied", "2-2": "If you specify incorrect date format.", "3-2": "The passed field is not present in the dataset.", "6-2": "Access to the dataset is denied.", "1-2": "If you fail to specify one or more field values in the request body.", "4-1": "Body cannot be empty", "4-0": "400 Bad Request", "5-1": "Limit exceeded upload rows = 10000", "5-0": "400 Bad Request", "4-2": "The request body is empty.", "5-2": "The request body contains more than 10000 rows." }, "cols": 3, "rows": 8 } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "Make sure that the values you are passing match the field types defined for your dataset schema. The number of fields you are passing should also completely match the number of fields in your dataset schema." } [/block] ##Rate Limits **Records per request** Slemma supports up to 10000 records per request.

User Information

Try It Out


post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "{\n \"RowsUpdated\": 2\n}", "0-2": "Everything worked correctly.", "1-0": "400 Bad Request", "1-1": "You need to set all field values in every passed row", "2-0": "400 Bad Request", "3-0": "400 Bad Request", "2-1": "Incorrect value '2016-1103 00:00:00.0' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'", "6-0": "403 Forbidden", "7-0": "404 Not Found", "7-2": "Dataset not found.", "3-1": "Field 'Example_Field' not found", "7-1": "Object not found", "6-1": "Access denied", "2-2": "If you specify incorrect date format.", "3-2": "The passed field is not present in the dataset.", "6-2": "Access to the dataset is denied.", "1-2": "If you fail to specify one or more field values in the request body.", "4-1": "Body cannot be empty", "4-0": "400 Bad Request", "5-1": "Limit exceeded upload rows = 10000", "5-0": "400 Bad Request", "4-2": "The request body is empty.", "5-2": "The request body contains more than 10000 rows." }, "cols": 3, "rows": 8 } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "Make sure that the values you are passing match the field types defined for your dataset schema. The number of fields you are passing should also completely match the number of fields in your dataset schema." } [/block] ##Rate Limits **Records per request** Slemma supports up to 10000 records per request.
{"_id":"583bc44e8fc62519008fc5b4","category":"5807634c6d47320f007a2f64","project":"5783990d5cbce30e0074e144","slug":"delere-records-from-custom-dataset","type":"delete","sync_unique":"","title":"Delete records from custom dataset","__v":1,"api":{"auth":"required","examples":{"codes":[{"code":"cURL -i -X DELETE \n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   -d [ \n       {\"Num of Days\":1,\"Start Date\":\"2016-10-04 00:00:00.0\",\"First Name\":\"John\",\"Location\":\"LA\"}\n      ] \nhttps://slemma.com/api/v1/data/424214","language":"curl"}]},"method":"delete","params":[{"_id":"583bfebbeb31f52d00415971","ref":"","in":"path","required":true,"desc":"The identifier of the custom dataset","default":"","type":"int","name":"key"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"RowsDeleted\": 0\n}","name":""},{"name":"","status":400,"language":"text","code":"Depending on the errors:\n1. Incorrect value 'example_text_value' of field 'Num of Days'\n2. Incorrect value '2016-10-04 00:00:00' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'\n3. You need to set all field values in when deleting a row"},{"status":403,"language":"text","code":"Access denied"},{"status":404,"language":"text","code":"Object not found"}]},"settings":"58297705702b940f004913d8","url":"/data/:key"},"body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Everything worked correctly.\",\n    \"0-1\": \"{\\n    \\\"RowsDeleted\\\": 0\\n}\",\n    \"0-0\": \"200 OK\",\n    \"1-0\": \"400 Bad Request\",\n    \"2-0\": \"400 Bad Request\",\n    \"4-0\": \"403 Forbidden\",\n    \"5-0\": \"404 Not Found\",\n    \"4-1\": \"Access denied\",\n    \"5-1\": \"Object not found\",\n    \"4-2\": \"Access to the dataset is denied.\",\n    \"5-2\": \"Dataset not found.\",\n    \"1-1\": \"Incorrect value '2016-10-04 00:00:00' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'\",\n    \"2-1\": \"Incorrect value 'example_text_value' of field 'Num of Days'\",\n    \"3-1\": \"You need to set all field values in when deleting a row\",\n    \"3-0\": \"400 Bad Request\",\n    \"2-2\": \"The passed values don’t match the field types specified in the custom dataset.\",\n    \"3-2\": \"You forgot to pass at least one field with its value in the request body.\",\n    \"1-2\": \"Specific case if you specify incorrect date format.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Note\",\n  \"body\": \"Make sure that the values you are passing match the field types defined for your dataset schema. The number of fields you are passing should also completely match the number of fields in your dataset schema.\\n\\nIf the request you pass does not match any of the records, the system will still return response code 200 (Success).\"\n}\n[/block]","createdAt":"2016-11-28T05:44:46.842Z","parentDoc":null,"updates":[],"user":"5492aa57f0d1810b0066005f","excerpt":"**Delete** records (rows) from a dataset by passing an array of key-value pair objects representing a record in your dataset.","githubsync":"","hidden":false,"isReference":true,"link_external":false,"next":{"pages":[],"description":""},"link_url":"","order":3,"version":"5783990d5cbce30e0074e145","childrenPages":[]}

deleteDelete records from custom dataset

**Delete** records (rows) from a dataset by passing an array of key-value pair objects representing a record in your dataset.

Path Params

key:
required
integer
The identifier of the custom dataset
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-2": "Everything worked correctly.", "0-1": "{\n \"RowsDeleted\": 0\n}", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "4-0": "403 Forbidden", "5-0": "404 Not Found", "4-1": "Access denied", "5-1": "Object not found", "4-2": "Access to the dataset is denied.", "5-2": "Dataset not found.", "1-1": "Incorrect value '2016-10-04 00:00:00' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'", "2-1": "Incorrect value 'example_text_value' of field 'Num of Days'", "3-1": "You need to set all field values in when deleting a row", "3-0": "400 Bad Request", "2-2": "The passed values don’t match the field types specified in the custom dataset.", "3-2": "You forgot to pass at least one field with its value in the request body.", "1-2": "Specific case if you specify incorrect date format." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "Make sure that the values you are passing match the field types defined for your dataset schema. The number of fields you are passing should also completely match the number of fields in your dataset schema.\n\nIf the request you pass does not match any of the records, the system will still return response code 200 (Success)." } [/block]

User Information

Try It Out


delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-2": "Everything worked correctly.", "0-1": "{\n \"RowsDeleted\": 0\n}", "0-0": "200 OK", "1-0": "400 Bad Request", "2-0": "400 Bad Request", "4-0": "403 Forbidden", "5-0": "404 Not Found", "4-1": "Access denied", "5-1": "Object not found", "4-2": "Access to the dataset is denied.", "5-2": "Dataset not found.", "1-1": "Incorrect value '2016-10-04 00:00:00' for field 'Start Date'. User the date format: 'yyyy-MM-dd HH:mm:ss.S'", "2-1": "Incorrect value 'example_text_value' of field 'Num of Days'", "3-1": "You need to set all field values in when deleting a row", "3-0": "400 Bad Request", "2-2": "The passed values don’t match the field types specified in the custom dataset.", "3-2": "You forgot to pass at least one field with its value in the request body.", "1-2": "Specific case if you specify incorrect date format." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "warning", "title": "Note", "body": "Make sure that the values you are passing match the field types defined for your dataset schema. The number of fields you are passing should also completely match the number of fields in your dataset schema.\n\nIf the request you pass does not match any of the records, the system will still return response code 200 (Success)." } [/block]
{"_id":"583c27cb5061b12d0044563d","slug":"delete-the-data","user":"5492aa57f0d1810b0066005f","createdAt":"2016-11-28T12:49:15.060Z","link_external":false,"category":"5807634c6d47320f007a2f64","order":4,"parentDoc":null,"title":"Delete the data","type":"delete","body":"The following are the examples of HTTP status codes including errors that API can generate\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Response codes\",\n    \"h-1\": \"Response content\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"200 OK\",\n    \"0-1\": \"{\\n    \\\"RowsDeleted\\\": 14\\n}\",\n    \"0-2\": \"Everything worked correctly.\",\n    \"1-0\": \"403 Forbidden\",\n    \"1-1\": \"Access denied\",\n    \"1-2\": \"Access to the dataset is denied.\",\n    \"2-0\": \"404 Not Found\",\n    \"2-2\": \"Dataset not found.\",\n    \"2-1\": \"Object not found\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","isReference":true,"link_url":"","next":{"pages":[],"description":""},"sync_unique":"","updates":[],"version":"5783990d5cbce30e0074e145","__v":0,"excerpt":"Permanently deletes all data from the Custom Dataset. **The operation cannot be undone.**","hidden":false,"project":"5783990d5cbce30e0074e144","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"RowsDeleted\": 14\n}","name":""},{"status":403,"language":"text","code":"Access denied","name":""},{"code":"Object not found","language":"text","status":404}]},"settings":"58297705702b940f004913d8","url":"/data/:key","auth":"required","examples":{"codes":[{"code":"cURL -i -X DELETE\n   -H teamid:131219\n   -H sig:a214bb15a05b1cde9a1e31d19d0660b18fb37394\n   -H Content-Type:application/json\n   https://slemma.com/api/v1/data/1815","language":"curl"}]},"method":"delete","params":[{"default":"The identifier of the custom dataset","type":"int","name":"key","_id":"5808b2aaa1174a0f007d9748","ref":"","in":"path","required":true,"desc":""}]},"githubsync":"","childrenPages":[]}

deleteDelete the data

Permanently deletes all data from the Custom Dataset. **The operation cannot be undone.**

Path Params

key:
required
integerThe identifier of the custom dataset
The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "{\n \"RowsDeleted\": 14\n}", "0-2": "Everything worked correctly.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the dataset is denied.", "2-0": "404 Not Found", "2-2": "Dataset not found.", "2-1": "Object not found" }, "cols": 3, "rows": 3 } [/block]

User Information

Try It Out


delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The following are the examples of HTTP status codes including errors that API can generate [block:parameters] { "data": { "h-0": "Response codes", "h-1": "Response content", "h-2": "Description", "0-0": "200 OK", "0-1": "{\n \"RowsDeleted\": 14\n}", "0-2": "Everything worked correctly.", "1-0": "403 Forbidden", "1-1": "Access denied", "1-2": "Access to the dataset is denied.", "2-0": "404 Not Found", "2-2": "Dataset not found.", "2-1": "Object not found" }, "cols": 3, "rows": 3 } [/block]
{"_id":"590963964d32992500896c3e","project":"5783990d5cbce30e0074e144","title":"Role","version":"5783990d5cbce30e0074e145","__v":0,"excerpt":"Possible values for Role Enum","hidden":false,"parentDoc":null,"slug":"role","githubsync":"","isReference":false,"link_external":false,"order":0,"sync_unique":"","type":"basic","updates":[],"body":"For more information about users roles you can visit our [product documentation](http://support.slemma.com/knowledge_base/topics/creating-a-team/#team-member-permissions).\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Owner\",\n    \"0-2\": \"1\",\n    \"0-1\": \"The team owner can manage team members, create/edit/share/delete objects in Slemma and manage subscriptions and billing information.\",\n    \"3-0\": \"User\",\n    \"3-1\": \"The user can create, delete, edit, and share objects, and use delivery if they have either Individual permissions on objects, or belong to Group or Team having those permissions.\\nIndividual permissions take precedence over Group or Team permissions.\\n\\nIn the UI the title of this role is determined by the [User Type](doc:teammembertype). If the User Type is set to Client, then you'll see 'client' in the users dropdown menu. Otherwise, you'll see 'Teammember'.\",\n    \"1-0\": \"Administrator\",\n    \"1-1\": \"The team administrator has all owner permissions, except for the access to payment and billing information, as well as the ability to upgrade the current plan and cancel the subscription.\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"2-0\": \"GroupAdmin\",\n    \"2-1\": \"In the UI the title of this role is determined by the [User Type](doc:teammembertype). If the User Type is set to Client, then you'll see 'client group admin' in the users dropdown menu. Otherwise, you'll see 'Teammember group admin'.\\n\\nThe group administrartor can add users to a group and create dashboard templates.\\n**To be able to add users to a group and create dashboard templates with this role you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"57848e0eb3a5402400fee911","link_url":"","next":{"pages":[],"description":""},"user":"5492aa57f0d1810b0066005f","api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"createdAt":"2017-05-03T04:59:02.513Z","childrenPages":[]}

Role

Possible values for Role Enum

For more information about users roles you can visit our [product documentation](http://support.slemma.com/knowledge_base/topics/creating-a-team/#team-member-permissions). [block:parameters] { "data": { "0-0": "Owner", "0-2": "1", "0-1": "The team owner can manage team members, create/edit/share/delete objects in Slemma and manage subscriptions and billing information.", "3-0": "User", "3-1": "The user can create, delete, edit, and share objects, and use delivery if they have either Individual permissions on objects, or belong to Group or Team having those permissions.\nIndividual permissions take precedence over Group or Team permissions.\n\nIn the UI the title of this role is determined by the [User Type](doc:teammembertype). If the User Type is set to Client, then you'll see 'client' in the users dropdown menu. Otherwise, you'll see 'Teammember'.", "1-0": "Administrator", "1-1": "The team administrator has all owner permissions, except for the access to payment and billing information, as well as the ability to upgrade the current plan and cancel the subscription.", "h-0": "Name", "h-1": "Description", "2-0": "GroupAdmin", "2-1": "In the UI the title of this role is determined by the [User Type](doc:teammembertype). If the User Type is set to Client, then you'll see 'client group admin' in the users dropdown menu. Otherwise, you'll see 'Teammember group admin'.\n\nThe group administrartor can add users to a group and create dashboard templates.\n**To be able to add users to a group and create dashboard templates with this role you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**" }, "cols": 2, "rows": 4 } [/block]
For more information about users roles you can visit our [product documentation](http://support.slemma.com/knowledge_base/topics/creating-a-team/#team-member-permissions). [block:parameters] { "data": { "0-0": "Owner", "0-2": "1", "0-1": "The team owner can manage team members, create/edit/share/delete objects in Slemma and manage subscriptions and billing information.", "3-0": "User", "3-1": "The user can create, delete, edit, and share objects, and use delivery if they have either Individual permissions on objects, or belong to Group or Team having those permissions.\nIndividual permissions take precedence over Group or Team permissions.\n\nIn the UI the title of this role is determined by the [User Type](doc:teammembertype). If the User Type is set to Client, then you'll see 'client' in the users dropdown menu. Otherwise, you'll see 'Teammember'.", "1-0": "Administrator", "1-1": "The team administrator has all owner permissions, except for the access to payment and billing information, as well as the ability to upgrade the current plan and cancel the subscription.", "h-0": "Name", "h-1": "Description", "2-0": "GroupAdmin", "2-1": "In the UI the title of this role is determined by the [User Type](doc:teammembertype). If the User Type is set to Client, then you'll see 'client group admin' in the users dropdown menu. Otherwise, you'll see 'Teammember group admin'.\n\nThe group administrartor can add users to a group and create dashboard templates.\n**To be able to add users to a group and create dashboard templates with this role you need this feature to be enabled for your account. Please send us an email at [help@slemma.com](mailto:help@slemma.com).**" }, "cols": 2, "rows": 4 } [/block]
{"_id":"590965c6651f500f001dd4e9","sync_unique":"","title":"UserType","updates":[],"version":"5783990d5cbce30e0074e145","body":"For more information about users types you can visit our [product documentation](http://support.slemma.com/knowledge_base/topics/creating-a-team-3).\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"User\",\n    \"1-0\": \"Client\",\n    \"0-1\": \"User is an internal member (colleague, company member) who is invited to the Team.\",\n    \"1-1\": \"Client is an external user who is invited to the Team in order to have access to the objects shared with him (dashboards, reports, presentations etc.). This is how you can give access to dashboards for clients when embedding Slemma's charts and dashboards.\\n\\nClients can also create their own objects (dashboards, datasets, etc.). However, they can only share objects to the group of users this client belongs to.\",\n    \"h-0\": \"Value\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nUser with the specified email address can be either a 'client' or a 'user'.","slug":"teammembertype","link_url":"","order":1,"parentDoc":null,"project":"5783990d5cbce30e0074e144","type":"basic","__v":0,"createdAt":"2017-05-03T05:08:22.579Z","githubsync":"","isReference":false,"next":{"pages":[],"description":""},"user":"5492aa57f0d1810b0066005f","category":"57848e0eb3a5402400fee911","excerpt":"Possible values for UserType Enum","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","settings":""},"link_external":false,"childrenPages":[]}

UserType

Possible values for UserType Enum

For more information about users types you can visit our [product documentation](http://support.slemma.com/knowledge_base/topics/creating-a-team-3). [block:parameters] { "data": { "0-0": "User", "1-0": "Client", "0-1": "User is an internal member (colleague, company member) who is invited to the Team.", "1-1": "Client is an external user who is invited to the Team in order to have access to the objects shared with him (dashboards, reports, presentations etc.). This is how you can give access to dashboards for clients when embedding Slemma's charts and dashboards.\n\nClients can also create their own objects (dashboards, datasets, etc.). However, they can only share objects to the group of users this client belongs to.", "h-0": "Value", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block] User with the specified email address can be either a 'client' or a 'user'.
For more information about users types you can visit our [product documentation](http://support.slemma.com/knowledge_base/topics/creating-a-team-3). [block:parameters] { "data": { "0-0": "User", "1-0": "Client", "0-1": "User is an internal member (colleague, company member) who is invited to the Team.", "1-1": "Client is an external user who is invited to the Team in order to have access to the objects shared with him (dashboards, reports, presentations etc.). This is how you can give access to dashboards for clients when embedding Slemma's charts and dashboards.\n\nClients can also create their own objects (dashboards, datasets, etc.). However, they can only share objects to the group of users this client belongs to.", "h-0": "Value", "h-1": "Description" }, "cols": 2, "rows": 2 } [/block] User with the specified email address can be either a 'client' or a 'user'.
{"_id":"5786009a760bd30e00e761dd","slug":"authtype","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","__v":10,"createdAt":"2016-07-13T08:49:30.811Z","hidden":false,"link_external":false,"type":"basic","githubsync":"","order":2,"project":"5783990d5cbce30e0074e144","sync_unique":"","parentDoc":null,"title":"AuthType","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]}},"category":"57848e0eb3a5402400fee911","isReference":false,"link_url":"","body":"AuthType determines the way how the user signed up for Slemma. The user may provide his email address (Slemma Login) or use one of the social sign in buttons.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Slemma Login\",\n    \"1-0\": \"Twitter\",\n    \"0-1\": \"Email address\",\n    \"1-1\": \"Twitter\",\n    \"h-0\": \"Value\",\n    \"h-1\": \"Description\",\n    \"2-0\": \"Facebook\",\n    \"3-0\": \"Google\",\n    \"4-0\": \"DropBox\",\n    \"5-0\": \"WinLiveId\",\n    \"6-0\": \"LinkedIn\",\n    \"2-1\": \"Facebook\",\n    \"3-1\": \"Google\",\n    \"4-1\": \"Dropbox\",\n    \"5-1\": \"Windows Live ID\",\n    \"6-1\": \"LinkedIn\",\n    \"7-0\": \"Slack\",\n    \"7-1\": \"Slack\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","excerpt":"Possible values for AuthType Enum","updates":[],"childrenPages":[]}

AuthType

Possible values for AuthType Enum

AuthType determines the way how the user signed up for Slemma. The user may provide his email address (Slemma Login) or use one of the social sign in buttons. [block:parameters] { "data": { "0-0": "Slemma Login", "1-0": "Twitter", "0-1": "Email address", "1-1": "Twitter", "h-0": "Value", "h-1": "Description", "2-0": "Facebook", "3-0": "Google", "4-0": "DropBox", "5-0": "WinLiveId", "6-0": "LinkedIn", "2-1": "Facebook", "3-1": "Google", "4-1": "Dropbox", "5-1": "Windows Live ID", "6-1": "LinkedIn", "7-0": "Slack", "7-1": "Slack" }, "cols": 2, "rows": 8 } [/block]
AuthType determines the way how the user signed up for Slemma. The user may provide his email address (Slemma Login) or use one of the social sign in buttons. [block:parameters] { "data": { "0-0": "Slemma Login", "1-0": "Twitter", "0-1": "Email address", "1-1": "Twitter", "h-0": "Value", "h-1": "Description", "2-0": "Facebook", "3-0": "Google", "4-0": "DropBox", "5-0": "WinLiveId", "6-0": "LinkedIn", "2-1": "Facebook", "3-1": "Google", "4-1": "Dropbox", "5-1": "Windows Live ID", "6-1": "LinkedIn", "7-0": "Slack", "7-1": "Slack" }, "cols": 2, "rows": 8 } [/block]
{"_id":"57872d8ebbe6c40e009f72a5","parentDoc":null,"api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","params":[]},"category":"57848e0eb3a5402400fee911","link_external":false,"next":{"description":"","pages":[]},"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","excerpt":"Possible values for ObjectType Enum","hidden":false,"isReference":false,"updates":[],"title":"ObjectType","createdAt":"2016-07-14T06:13:34.940Z","link_url":"","project":"5783990d5cbce30e0074e144","slug":"object-type","sync_unique":"","type":"basic","__v":5,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"report\",\n    \"1-0\": \"dashboard\",\n    \"2-0\": \"presentation\",\n    \"3-0\": \"folder\",\n    \"4-0\": \"dataset\",\n    \"5-0\": \"integration\",\n    \"h-0\": \"Type name\",\n    \"h-1\": \"ID\",\n    \"0-1\": \"6\",\n    \"1-1\": \"2\",\n    \"3-1\": \"3\",\n    \"2-1\": \"7\"\n  },\n  \"cols\": 1,\n  \"rows\": 6\n}\n[/block]","githubsync":"","order":3,"childrenPages":[]}

ObjectType

Possible values for ObjectType Enum

[block:parameters] { "data": { "0-0": "report", "1-0": "dashboard", "2-0": "presentation", "3-0": "folder", "4-0": "dataset", "5-0": "integration", "h-0": "Type name", "h-1": "ID", "0-1": "6", "1-1": "2", "3-1": "3", "2-1": "7" }, "cols": 1, "rows": 6 } [/block]
[block:parameters] { "data": { "0-0": "report", "1-0": "dashboard", "2-0": "presentation", "3-0": "folder", "4-0": "dataset", "5-0": "integration", "h-0": "Type name", "h-1": "ID", "0-1": "6", "1-1": "2", "3-1": "3", "2-1": "7" }, "cols": 1, "rows": 6 } [/block]
{"_id":"57baea1d6436180e006ea3d6","body":"## File\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Ext type name\",\n    \"h-1\": \"UI Name\",\n    \"0-0\": \"CSV\",\n    \"1-0\": \"URL\",\n    \"1-1\": \"File by URL\",\n    \"0-1\": \"Upload a File\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n## Custom dataset\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Ext type name\",\n    \"h-1\": \"UI Name\",\n    \"0-1\": \"Custom dataset\",\n    \"0-0\": \"Manual-API\",\n    \"1-1\": \"Zapier dataset\",\n    \"1-0\": \"Zapier\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n \n## Cloud storage \n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"UI Name\",\n    \"h-0\": \"Ext type name\",\n    \"0-0\": \"AmazonCD\",\n    \"1-0\": \"Box\",\n    \"2-0\": \"DropBox\",\n    \"3-0\": \"GDrive\",\n    \"4-0\": \"OneDrive\",\n    \"0-1\": \"Amazon Cloud Drive\",\n    \"1-1\": \"Box\",\n    \"2-1\": \"DropBox\",\n    \"3-1\": \"Google Drive\",\n    \"4-1\": \"OneDrive\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n## Databases \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Ext type name\",\n    \"h-1\": \"UI Name\",\n    \"0-0\": \"AzureSQLDatabase\",\n    \"1-0\": \"DB2\",\n    \"1-1\": \"DB2\",\n    \"2-0\": \"GoogleBigQuery\",\n    \"2-1\": \"Google BigQuery\",\n    \"3-0\": \"HANA\",\n    \"4-0\": \"HerokuPG\",\n    \"4-1\": \"Heroku PostgreSQL\",\n    \"3-1\": \"SAP HANA\",\n    \"0-1\": \"Microsoft Azure SQL\",\n    \"5-0\": \"MariaDB\",\n    \"5-1\": \"MariaDB\",\n    \"6-0\": \"MonetDB\",\n    \"6-1\": \"MonetDB\",\n    \"7-0\": \"MongoDb\",\n    \"7-1\": \"MongoDb\",\n    \"8-0\": \"MySQL\",\n    \"8-1\": \"MySQL\",\n    \"9-0\": \"MySQLRDS\",\n    \"9-1\": \"Amazon RDS MySQL\",\n    \"10-0\": \"Oracle\",\n    \"10-1\": \"Oracle\",\n    \"11-0\": \"PostgreSQL\",\n    \"11-1\": \"PostgreSQL\",\n    \"12-0\": \"PostgreSQLRDS\",\n    \"12-1\": \"Amazon RDS PostgreSQL\",\n    \"13-0\": \"Presto\",\n    \"13-1\": \"Presto\",\n    \"14-0\": \"Redshift\",\n    \"14-1\": \"Amazon Redshift\",\n    \"15-0\": \"SQLServer\",\n    \"15-1\": \"MS SQL Server\",\n    \"16-0\": \"Teradata\",\n    \"16-1\": \"Teradata\",\n    \"17-0\": \"TreasureData\",\n    \"17-1\": \"TreasureData\",\n    \"18-0\": \"Vertica\",\n    \"18-1\": \"Vertica\",\n    \"19-0\": \"XMLA\",\n    \"19-1\": \"SAP BW,\\t\\nPentaho BI\\t\\nMS SAAS\\t\\nOracle BI\",\n    \"h-2\": \"Driver\",\n    \"10-2\": \"oracle\",\n    \"18-2\": \"vertica\",\n    \"16-2\": \"teradata\",\n    \"4-2\": \"postgresql\",\n    \"17-2\": \"treasuredata\",\n    \"7-2\": \"mongodb\",\n    \"15-2\": \"sqlserver\",\n    \"2-2\": \"BQDriver\",\n    \"11-2\": \"postgresql\",\n    \"8-2\": \"mysql\",\n    \"14-2\": \"redshift\",\n    \"5-2\": \"mariadb\",\n    \"3-2\": \"sap\",\n    \"6-2\": \"monetdb\",\n    \"9-2\": \"mysql\",\n    \"12-2\": \"postgresql\",\n    \"13-2\": \"presto\",\n    \"1-2\": \"db2\",\n    \"0-2\": \"sqlserver\",\n    \"19-2\": \"xmla\"\n  },\n  \"cols\": 3,\n  \"rows\": 20\n}\n[/block]\n## Cloud services \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Ext type name\",\n    \"h-1\": \"UI Name\",\n    \"h-2\": \"Category\",\n    \"0-0\": \"3dcart\",\n    \"2-0\": \"Authorize.Net\",\n    \"0-1\": \"3dcart\",\n    \"0-2\": \"Cloud services\",\n    \"3-0\": \"BigCommerce\",\n    \"4-0\": \"BrainTree\",\n    \"5-0\": \"Campaign Monitor\",\n    \"6-0\": \"Chargify\",\n    \"8-0\": \"GitHub\",\n    \"10-0\": \"Google Analytics\",\n    \"11-0\": \"Hubspot\",\n    \"15-0\": \"Intercom\",\n    \"16-0\": \"Jira\",\n    \"17-0\": \"Magento\",\n    \"18-0\": \"MailChimp\",\n    \"19-0\": \"Marketo\",\n    \"20-0\": \"Mixpanel\",\n    \"22-0\": \"NewRelic\",\n    \"23-0\": \"Pingdom\",\n    \"24-0\": \"Pipedrive\",\n    \"25-0\": \"PrestaShop\",\n    \"26-0\": \"QuickBooks\",\n    \"27-0\": \"Recurly\",\n    \"29-0\": \"Saleforce\",\n    \"30-0\": \"Shopify\",\n    \"31-0\": \"Slack\",\n    \"32-0\": \"Smartsheet\",\n    \"33-0\": \"Stripe\",\n    \"35-0\": \"Toogl\",\n    \"37-0\": \"WordPress.com\",\n    \"38-0\": \"Zendesk\",\n    \"38-1\": \"Zendesk\",\n    \"37-1\": \"WordPress.com\",\n    \"35-1\": \"Toogl\",\n    \"33-1\": \"Stripe\",\n    \"32-1\": \"Smartsheet\",\n    \"31-1\": \"Slack\",\n    \"30-1\": \"Shopify\",\n    \"29-1\": \"Saleforce\",\n    \"27-1\": \"Recurly\",\n    \"26-1\": \"QuickBooks\",\n    \"25-1\": \"Prestashop\",\n    \"24-1\": \"Pipedrive\",\n    \"23-1\": \"Pingdom\",\n    \"22-1\": \"NewRelic\",\n    \"20-1\": \"Mixpanel\",\n    \"19-1\": \"Marketo\",\n    \"18-1\": \"MailChimp\",\n    \"17-1\": \"Magento\",\n    \"16-1\": \"Jira\",\n    \"15-1\": \"Intercom\",\n    \"11-1\": \"Hubspot\",\n    \"10-1\": \"Google Analytics\",\n    \"8-1\": \"GitHub\",\n    \"6-1\": \"Chargify\",\n    \"5-1\": \"Campaign Monitor\",\n    \"4-1\": \"BrainTree\",\n    \"3-1\": \"BigCommerce\",\n    \"2-1\": \"Authorize.Net\",\n    \"2-2\": \"Cloud services\",\n    \"3-2\": \"Cloud services\",\n    \"4-2\": \"Cloud services\",\n    \"5-2\": \"Cloud services\",\n    \"6-2\": \"Cloud services\",\n    \"8-2\": \"Cloud services\",\n    \"10-2\": \"Cloud services\",\n    \"11-2\": \"Cloud services\",\n    \"15-2\": \"Cloud services\",\n    \"16-2\": \"Cloud services\",\n    \"17-2\": \"Cloud services\",\n    \"18-2\": \"Cloud services\",\n    \"19-2\": \"Cloud services\",\n    \"20-2\": \"Cloud services\",\n    \"22-2\": \"Cloud services\",\n    \"23-2\": \"Cloud services\",\n    \"24-2\": \"Cloud services\",\n    \"25-2\": \"Cloud services\",\n    \"26-2\": \"Cloud services\",\n    \"27-2\": \"Cloud services\",\n    \"29-2\": \"Cloud services\",\n    \"30-2\": \"Cloud services\",\n    \"31-2\": \"Cloud services\",\n    \"32-2\": \"Cloud services\",\n    \"33-2\": \"Cloud services\",\n    \"35-2\": \"Cloud services\",\n    \"38-2\": \"Cloud services\",\n    \"37-2\": \"Cloud services\",\n    \"39-0\": \"Zoho\",\n    \"39-1\": \"Zoho\",\n    \"12-0\": \"Infusionsoft\",\n    \"12-1\": \"Infusionsoft\",\n    \"13-0\": \"Insightly\",\n    \"13-1\": \"Insightly\",\n    \"1-0\": \"AdRoll\",\n    \"7-0\": \"FreshBooks\",\n    \"1-1\": \"AdRoll\",\n    \"7-1\": \"FreshBooks\",\n    \"9-1\": \"Google AdWords\",\n    \"21-1\": \"Moz\",\n    \"28-1\": \"SageOne\",\n    \"34-1\": \"SurveyMonkey\",\n    \"36-1\": \"WooCommerce\",\n    \"9-0\": \"Google AdWords\",\n    \"21-0\": \"Moz\",\n    \"28-0\": \"SageOne\",\n    \"34-0\": \"SurveyMonkey\",\n    \"36-0\": \"WooCommerce\",\n    \"14-0\": \"Intacct\",\n    \"14-1\": \"Intacct\"\n  },\n  \"cols\": 2,\n  \"rows\": 40\n}\n[/block]\n## Report \n**The type of chart was used to create a report**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Ext type name\",\n    \"h-1\": \"UI Name\",\n    \"0-0\": \"Column\",\n    \"1-0\": \"ColumnHistogram\",\n    \"2-0\": \"BarHistogram\",\n    \"3-0\": \"ColumnI\",\n    \"6-0\": \"ComboChart\",\n    \"4-0\": \"Line\",\n    \"7-0\": \"Bullet\",\n    \"9-0\": \"TreeMap\",\n    \"10-0\": \"Table\",\n    \"11-0\": \"ColumnTable\",\n    \"0-1\": \"Column and Bar->Column->Vertical\",\n    \"1-1\": \"Column and Bar->Histogram->Vertical\",\n    \"2-1\": \"Column and Bar->Histogram->Horizontal\",\n    \"3-1\": \"Column and Bar->Column->Horizontal\",\n    \"4-1\": \"Timeline->Line\",\n    \"6-1\": \"Combo\",\n    \"7-1\": \"Bullet->Vertical\",\n    \"9-1\": \"Treemap\",\n    \"10-1\": \"Table->Pivot\",\n    \"11-1\": \"Table->Raw data\",\n    \"5-0\": \"Area\",\n    \"5-1\": \"Timeline->Area\",\n    \"8-0\": \"BulletI\",\n    \"8-1\": \"Bullet->Horizontal\",\n    \"12-0\": \"BubbleChart\",\n    \"12-1\": \"Scatter plot\",\n    \"13-1\": \"Funnel->Pyramid\",\n    \"13-0\": \"MetricFunnel\",\n    \"14-1\": \"Funnel->Single color\",\n    \"14-0\": \"FunnelColumn\",\n    \"15-1\": \"Funnel->Multicolor\",\n    \"15-0\": \"FunnelColumnColor\",\n    \"16-0\": \"SingleValue\",\n    \"16-1\": \"Single value->Single value\",\n    \"17-1\": \"Single value->Gaude\",\n    \"17-0\": \"Gaude\",\n    \"18-1\": \"Single value->Progress bar\",\n    \"18-0\": \"ProgressBar\",\n    \"19-1\": \"Pie and donut->Pie\",\n    \"19-0\": \"Radial\",\n    \"20-1\": \"Pie and donut->Donut\",\n    \"20-0\": \"Donut\",\n    \"21-1\": \"Pie and donut->Donut with total\",\n    \"21-0\": \"DonutTotal\",\n    \"22-1\": \"Pie and donut->Funnel\",\n    \"22-0\": \"Funnel\",\n    \"23-1\": \"Pictorial->Word cloud\",\n    \"24-1\": \"Pictorial->Pictorial (amount)\",\n    \"25-1\": \"Pictorial->Pictorial (size)\",\n    \"23-0\": \"WordCloud\",\n    \"24-0\": \"Pictorial\",\n    \"25-0\": \"PictorialSize\",\n    \"26-1\": \"Map->Filled\",\n    \"27-1\": \"Map->Symbol\",\n    \"26-0\": \"Map\",\n    \"27-0\": \"GeoMap\"\n  },\n  \"cols\": 2,\n  \"rows\": 28\n}\n[/block]","createdAt":"2016-08-22T12:03:41.403Z","link_external":false,"next":{"pages":[],"description":""},"parentDoc":null,"slug":"exttype","link_url":"","order":4,"project":"5783990d5cbce30e0074e144","sync_unique":"","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","githubsync":"","hidden":false,"isReference":false,"title":"ExtType","updates":[],"__v":1,"api":{"auth":"required","params":[],"url":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"category":"57848e0eb3a5402400fee911","excerpt":"Possible values for ObjectType Enum. Valid for Reports, Integrations and Datasets only.","type":"basic","childrenPages":[]}

ExtType

Possible values for ObjectType Enum. Valid for Reports, Integrations and Datasets only.

## File [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-0": "CSV", "1-0": "URL", "1-1": "File by URL", "0-1": "Upload a File" }, "cols": 2, "rows": 2 } [/block] ## Custom dataset [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-1": "Custom dataset", "0-0": "Manual-API", "1-1": "Zapier dataset", "1-0": "Zapier" }, "cols": 2, "rows": 2 } [/block] ## Cloud storage [block:parameters] { "data": { "h-1": "UI Name", "h-0": "Ext type name", "0-0": "AmazonCD", "1-0": "Box", "2-0": "DropBox", "3-0": "GDrive", "4-0": "OneDrive", "0-1": "Amazon Cloud Drive", "1-1": "Box", "2-1": "DropBox", "3-1": "Google Drive", "4-1": "OneDrive" }, "cols": 2, "rows": 5 } [/block] ## Databases [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-0": "AzureSQLDatabase", "1-0": "DB2", "1-1": "DB2", "2-0": "GoogleBigQuery", "2-1": "Google BigQuery", "3-0": "HANA", "4-0": "HerokuPG", "4-1": "Heroku PostgreSQL", "3-1": "SAP HANA", "0-1": "Microsoft Azure SQL", "5-0": "MariaDB", "5-1": "MariaDB", "6-0": "MonetDB", "6-1": "MonetDB", "7-0": "MongoDb", "7-1": "MongoDb", "8-0": "MySQL", "8-1": "MySQL", "9-0": "MySQLRDS", "9-1": "Amazon RDS MySQL", "10-0": "Oracle", "10-1": "Oracle", "11-0": "PostgreSQL", "11-1": "PostgreSQL", "12-0": "PostgreSQLRDS", "12-1": "Amazon RDS PostgreSQL", "13-0": "Presto", "13-1": "Presto", "14-0": "Redshift", "14-1": "Amazon Redshift", "15-0": "SQLServer", "15-1": "MS SQL Server", "16-0": "Teradata", "16-1": "Teradata", "17-0": "TreasureData", "17-1": "TreasureData", "18-0": "Vertica", "18-1": "Vertica", "19-0": "XMLA", "19-1": "SAP BW,\t\nPentaho BI\t\nMS SAAS\t\nOracle BI", "h-2": "Driver", "10-2": "oracle", "18-2": "vertica", "16-2": "teradata", "4-2": "postgresql", "17-2": "treasuredata", "7-2": "mongodb", "15-2": "sqlserver", "2-2": "BQDriver", "11-2": "postgresql", "8-2": "mysql", "14-2": "redshift", "5-2": "mariadb", "3-2": "sap", "6-2": "monetdb", "9-2": "mysql", "12-2": "postgresql", "13-2": "presto", "1-2": "db2", "0-2": "sqlserver", "19-2": "xmla" }, "cols": 3, "rows": 20 } [/block] ## Cloud services [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "h-2": "Category", "0-0": "3dcart", "2-0": "Authorize.Net", "0-1": "3dcart", "0-2": "Cloud services", "3-0": "BigCommerce", "4-0": "BrainTree", "5-0": "Campaign Monitor", "6-0": "Chargify", "8-0": "GitHub", "10-0": "Google Analytics", "11-0": "Hubspot", "15-0": "Intercom", "16-0": "Jira", "17-0": "Magento", "18-0": "MailChimp", "19-0": "Marketo", "20-0": "Mixpanel", "22-0": "NewRelic", "23-0": "Pingdom", "24-0": "Pipedrive", "25-0": "PrestaShop", "26-0": "QuickBooks", "27-0": "Recurly", "29-0": "Saleforce", "30-0": "Shopify", "31-0": "Slack", "32-0": "Smartsheet", "33-0": "Stripe", "35-0": "Toogl", "37-0": "WordPress.com", "38-0": "Zendesk", "38-1": "Zendesk", "37-1": "WordPress.com", "35-1": "Toogl", "33-1": "Stripe", "32-1": "Smartsheet", "31-1": "Slack", "30-1": "Shopify", "29-1": "Saleforce", "27-1": "Recurly", "26-1": "QuickBooks", "25-1": "Prestashop", "24-1": "Pipedrive", "23-1": "Pingdom", "22-1": "NewRelic", "20-1": "Mixpanel", "19-1": "Marketo", "18-1": "MailChimp", "17-1": "Magento", "16-1": "Jira", "15-1": "Intercom", "11-1": "Hubspot", "10-1": "Google Analytics", "8-1": "GitHub", "6-1": "Chargify", "5-1": "Campaign Monitor", "4-1": "BrainTree", "3-1": "BigCommerce", "2-1": "Authorize.Net", "2-2": "Cloud services", "3-2": "Cloud services", "4-2": "Cloud services", "5-2": "Cloud services", "6-2": "Cloud services", "8-2": "Cloud services", "10-2": "Cloud services", "11-2": "Cloud services", "15-2": "Cloud services", "16-2": "Cloud services", "17-2": "Cloud services", "18-2": "Cloud services", "19-2": "Cloud services", "20-2": "Cloud services", "22-2": "Cloud services", "23-2": "Cloud services", "24-2": "Cloud services", "25-2": "Cloud services", "26-2": "Cloud services", "27-2": "Cloud services", "29-2": "Cloud services", "30-2": "Cloud services", "31-2": "Cloud services", "32-2": "Cloud services", "33-2": "Cloud services", "35-2": "Cloud services", "38-2": "Cloud services", "37-2": "Cloud services", "39-0": "Zoho", "39-1": "Zoho", "12-0": "Infusionsoft", "12-1": "Infusionsoft", "13-0": "Insightly", "13-1": "Insightly", "1-0": "AdRoll", "7-0": "FreshBooks", "1-1": "AdRoll", "7-1": "FreshBooks", "9-1": "Google AdWords", "21-1": "Moz", "28-1": "SageOne", "34-1": "SurveyMonkey", "36-1": "WooCommerce", "9-0": "Google AdWords", "21-0": "Moz", "28-0": "SageOne", "34-0": "SurveyMonkey", "36-0": "WooCommerce", "14-0": "Intacct", "14-1": "Intacct" }, "cols": 2, "rows": 40 } [/block] ## Report **The type of chart was used to create a report** [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-0": "Column", "1-0": "ColumnHistogram", "2-0": "BarHistogram", "3-0": "ColumnI", "6-0": "ComboChart", "4-0": "Line", "7-0": "Bullet", "9-0": "TreeMap", "10-0": "Table", "11-0": "ColumnTable", "0-1": "Column and Bar->Column->Vertical", "1-1": "Column and Bar->Histogram->Vertical", "2-1": "Column and Bar->Histogram->Horizontal", "3-1": "Column and Bar->Column->Horizontal", "4-1": "Timeline->Line", "6-1": "Combo", "7-1": "Bullet->Vertical", "9-1": "Treemap", "10-1": "Table->Pivot", "11-1": "Table->Raw data", "5-0": "Area", "5-1": "Timeline->Area", "8-0": "BulletI", "8-1": "Bullet->Horizontal", "12-0": "BubbleChart", "12-1": "Scatter plot", "13-1": "Funnel->Pyramid", "13-0": "MetricFunnel", "14-1": "Funnel->Single color", "14-0": "FunnelColumn", "15-1": "Funnel->Multicolor", "15-0": "FunnelColumnColor", "16-0": "SingleValue", "16-1": "Single value->Single value", "17-1": "Single value->Gaude", "17-0": "Gaude", "18-1": "Single value->Progress bar", "18-0": "ProgressBar", "19-1": "Pie and donut->Pie", "19-0": "Radial", "20-1": "Pie and donut->Donut", "20-0": "Donut", "21-1": "Pie and donut->Donut with total", "21-0": "DonutTotal", "22-1": "Pie and donut->Funnel", "22-0": "Funnel", "23-1": "Pictorial->Word cloud", "24-1": "Pictorial->Pictorial (amount)", "25-1": "Pictorial->Pictorial (size)", "23-0": "WordCloud", "24-0": "Pictorial", "25-0": "PictorialSize", "26-1": "Map->Filled", "27-1": "Map->Symbol", "26-0": "Map", "27-0": "GeoMap" }, "cols": 2, "rows": 28 } [/block]
## File [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-0": "CSV", "1-0": "URL", "1-1": "File by URL", "0-1": "Upload a File" }, "cols": 2, "rows": 2 } [/block] ## Custom dataset [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-1": "Custom dataset", "0-0": "Manual-API", "1-1": "Zapier dataset", "1-0": "Zapier" }, "cols": 2, "rows": 2 } [/block] ## Cloud storage [block:parameters] { "data": { "h-1": "UI Name", "h-0": "Ext type name", "0-0": "AmazonCD", "1-0": "Box", "2-0": "DropBox", "3-0": "GDrive", "4-0": "OneDrive", "0-1": "Amazon Cloud Drive", "1-1": "Box", "2-1": "DropBox", "3-1": "Google Drive", "4-1": "OneDrive" }, "cols": 2, "rows": 5 } [/block] ## Databases [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-0": "AzureSQLDatabase", "1-0": "DB2", "1-1": "DB2", "2-0": "GoogleBigQuery", "2-1": "Google BigQuery", "3-0": "HANA", "4-0": "HerokuPG", "4-1": "Heroku PostgreSQL", "3-1": "SAP HANA", "0-1": "Microsoft Azure SQL", "5-0": "MariaDB", "5-1": "MariaDB", "6-0": "MonetDB", "6-1": "MonetDB", "7-0": "MongoDb", "7-1": "MongoDb", "8-0": "MySQL", "8-1": "MySQL", "9-0": "MySQLRDS", "9-1": "Amazon RDS MySQL", "10-0": "Oracle", "10-1": "Oracle", "11-0": "PostgreSQL", "11-1": "PostgreSQL", "12-0": "PostgreSQLRDS", "12-1": "Amazon RDS PostgreSQL", "13-0": "Presto", "13-1": "Presto", "14-0": "Redshift", "14-1": "Amazon Redshift", "15-0": "SQLServer", "15-1": "MS SQL Server", "16-0": "Teradata", "16-1": "Teradata", "17-0": "TreasureData", "17-1": "TreasureData", "18-0": "Vertica", "18-1": "Vertica", "19-0": "XMLA", "19-1": "SAP BW,\t\nPentaho BI\t\nMS SAAS\t\nOracle BI", "h-2": "Driver", "10-2": "oracle", "18-2": "vertica", "16-2": "teradata", "4-2": "postgresql", "17-2": "treasuredata", "7-2": "mongodb", "15-2": "sqlserver", "2-2": "BQDriver", "11-2": "postgresql", "8-2": "mysql", "14-2": "redshift", "5-2": "mariadb", "3-2": "sap", "6-2": "monetdb", "9-2": "mysql", "12-2": "postgresql", "13-2": "presto", "1-2": "db2", "0-2": "sqlserver", "19-2": "xmla" }, "cols": 3, "rows": 20 } [/block] ## Cloud services [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "h-2": "Category", "0-0": "3dcart", "2-0": "Authorize.Net", "0-1": "3dcart", "0-2": "Cloud services", "3-0": "BigCommerce", "4-0": "BrainTree", "5-0": "Campaign Monitor", "6-0": "Chargify", "8-0": "GitHub", "10-0": "Google Analytics", "11-0": "Hubspot", "15-0": "Intercom", "16-0": "Jira", "17-0": "Magento", "18-0": "MailChimp", "19-0": "Marketo", "20-0": "Mixpanel", "22-0": "NewRelic", "23-0": "Pingdom", "24-0": "Pipedrive", "25-0": "PrestaShop", "26-0": "QuickBooks", "27-0": "Recurly", "29-0": "Saleforce", "30-0": "Shopify", "31-0": "Slack", "32-0": "Smartsheet", "33-0": "Stripe", "35-0": "Toogl", "37-0": "WordPress.com", "38-0": "Zendesk", "38-1": "Zendesk", "37-1": "WordPress.com", "35-1": "Toogl", "33-1": "Stripe", "32-1": "Smartsheet", "31-1": "Slack", "30-1": "Shopify", "29-1": "Saleforce", "27-1": "Recurly", "26-1": "QuickBooks", "25-1": "Prestashop", "24-1": "Pipedrive", "23-1": "Pingdom", "22-1": "NewRelic", "20-1": "Mixpanel", "19-1": "Marketo", "18-1": "MailChimp", "17-1": "Magento", "16-1": "Jira", "15-1": "Intercom", "11-1": "Hubspot", "10-1": "Google Analytics", "8-1": "GitHub", "6-1": "Chargify", "5-1": "Campaign Monitor", "4-1": "BrainTree", "3-1": "BigCommerce", "2-1": "Authorize.Net", "2-2": "Cloud services", "3-2": "Cloud services", "4-2": "Cloud services", "5-2": "Cloud services", "6-2": "Cloud services", "8-2": "Cloud services", "10-2": "Cloud services", "11-2": "Cloud services", "15-2": "Cloud services", "16-2": "Cloud services", "17-2": "Cloud services", "18-2": "Cloud services", "19-2": "Cloud services", "20-2": "Cloud services", "22-2": "Cloud services", "23-2": "Cloud services", "24-2": "Cloud services", "25-2": "Cloud services", "26-2": "Cloud services", "27-2": "Cloud services", "29-2": "Cloud services", "30-2": "Cloud services", "31-2": "Cloud services", "32-2": "Cloud services", "33-2": "Cloud services", "35-2": "Cloud services", "38-2": "Cloud services", "37-2": "Cloud services", "39-0": "Zoho", "39-1": "Zoho", "12-0": "Infusionsoft", "12-1": "Infusionsoft", "13-0": "Insightly", "13-1": "Insightly", "1-0": "AdRoll", "7-0": "FreshBooks", "1-1": "AdRoll", "7-1": "FreshBooks", "9-1": "Google AdWords", "21-1": "Moz", "28-1": "SageOne", "34-1": "SurveyMonkey", "36-1": "WooCommerce", "9-0": "Google AdWords", "21-0": "Moz", "28-0": "SageOne", "34-0": "SurveyMonkey", "36-0": "WooCommerce", "14-0": "Intacct", "14-1": "Intacct" }, "cols": 2, "rows": 40 } [/block] ## Report **The type of chart was used to create a report** [block:parameters] { "data": { "h-0": "Ext type name", "h-1": "UI Name", "0-0": "Column", "1-0": "ColumnHistogram", "2-0": "BarHistogram", "3-0": "ColumnI", "6-0": "ComboChart", "4-0": "Line", "7-0": "Bullet", "9-0": "TreeMap", "10-0": "Table", "11-0": "ColumnTable", "0-1": "Column and Bar->Column->Vertical", "1-1": "Column and Bar->Histogram->Vertical", "2-1": "Column and Bar->Histogram->Horizontal", "3-1": "Column and Bar->Column->Horizontal", "4-1": "Timeline->Line", "6-1": "Combo", "7-1": "Bullet->Vertical", "9-1": "Treemap", "10-1": "Table->Pivot", "11-1": "Table->Raw data", "5-0": "Area", "5-1": "Timeline->Area", "8-0": "BulletI", "8-1": "Bullet->Horizontal", "12-0": "BubbleChart", "12-1": "Scatter plot", "13-1": "Funnel->Pyramid", "13-0": "MetricFunnel", "14-1": "Funnel->Single color", "14-0": "FunnelColumn", "15-1": "Funnel->Multicolor", "15-0": "FunnelColumnColor", "16-0": "SingleValue", "16-1": "Single value->Single value", "17-1": "Single value->Gaude", "17-0": "Gaude", "18-1": "Single value->Progress bar", "18-0": "ProgressBar", "19-1": "Pie and donut->Pie", "19-0": "Radial", "20-1": "Pie and donut->Donut", "20-0": "Donut", "21-1": "Pie and donut->Donut with total", "21-0": "DonutTotal", "22-1": "Pie and donut->Funnel", "22-0": "Funnel", "23-1": "Pictorial->Word cloud", "24-1": "Pictorial->Pictorial (amount)", "25-1": "Pictorial->Pictorial (size)", "23-0": "WordCloud", "24-0": "Pictorial", "25-0": "PictorialSize", "26-1": "Map->Filled", "27-1": "Map->Symbol", "26-0": "Map", "27-0": "GeoMap" }, "cols": 2, "rows": 28 } [/block]
{"_id":"57c5681689df2b1700ed98b6","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"auth":"required","params":[],"url":"","settings":""},"hidden":false,"link_external":false,"sync_unique":"","parentDoc":null,"slug":"sourcetype","title":"SourceType","__v":0,"body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Cube\",\n    \"1-0\": \"Flat\",\n    \"2-0\": \"ChartConnector\",\n    \"h-0\": \"Source type name\",\n    \"h-1\": \"ID\",\n    \"0-1\": \"6\",\n    \"1-1\": \"2\",\n    \"2-1\": \"7\"\n  },\n  \"cols\": 1,\n  \"rows\": 3\n}\n[/block]","category":"57848e0eb3a5402400fee911","isReference":false,"link_url":"","user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","type":"basic","updates":[],"createdAt":"2016-08-30T11:03:50.407Z","excerpt":"Possible values for SourceType Enum","githubsync":"","order":5,"project":"5783990d5cbce30e0074e144","childrenPages":[]}

SourceType

Possible values for SourceType Enum

[block:parameters] { "data": { "0-0": "Cube", "1-0": "Flat", "2-0": "ChartConnector", "h-0": "Source type name", "h-1": "ID", "0-1": "6", "1-1": "2", "2-1": "7" }, "cols": 1, "rows": 3 } [/block]
[block:parameters] { "data": { "0-0": "Cube", "1-0": "Flat", "2-0": "ChartConnector", "h-0": "Source type name", "h-1": "ID", "0-1": "6", "1-1": "2", "2-1": "7" }, "cols": 1, "rows": 3 } [/block]
{"_id":"584a5551be6ca01b00e9ba71","project":"5783990d5cbce30e0074e144","title":"Permissions","type":"basic","category":"57848e0eb3a5402400fee911","next":{"pages":[],"description":""},"slug":"permissions","updates":[],"user":"5492aa57f0d1810b0066005f","version":"5783990d5cbce30e0074e145","hidden":false,"order":6,"createdAt":"2016-12-09T06:55:13.353Z","isReference":false,"sync_unique":"","__v":0,"api":{"settings":"","auth":"required","params":[],"url":"","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]}},"excerpt":"Define which actions users can perform with objects. Permission subjects are User (Individual), Group and Team.  Individual permissions override Group permissions, which in turn override Team permissions.","githubsync":"","link_external":false,"link_url":"","parentDoc":null,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"View\",\n    \"1-0\": \"Edit\",\n    \"2-0\": \"EditWithAccessEdit\",\n    \"3-0\": \"Blocked\",\n    \"3-1\": \"Apply when a subject is to be explicitly denied access to an object.\\n\\nCan only be used when setting Individual and Group permissions. **Not applicable when setting Team permissions**.\",\n    \"0-1\": \"Apply when a subject is to be granted read-only permission to an object.\",\n    \"4-0\": \"Null\",\n    \"1-1\": \"Apply when a subject is to be granted editing rights to an object.\",\n    \"2-1\": \"Apply when a subject is to be granted editing rights to an object, but this option also grants publishing rights.\",\n    \"4-1\": \"Apply to reset subject's permissions to an object.\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","childrenPages":[]}

Permissions

Define which actions users can perform with objects. Permission subjects are User (Individual), Group and Team. Individual permissions override Group permissions, which in turn override Team permissions.

[block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "View", "1-0": "Edit", "2-0": "EditWithAccessEdit", "3-0": "Blocked", "3-1": "Apply when a subject is to be explicitly denied access to an object.\n\nCan only be used when setting Individual and Group permissions. **Not applicable when setting Team permissions**.", "0-1": "Apply when a subject is to be granted read-only permission to an object.", "4-0": "Null", "1-1": "Apply when a subject is to be granted editing rights to an object.", "2-1": "Apply when a subject is to be granted editing rights to an object, but this option also grants publishing rights.", "4-1": "Apply to reset subject's permissions to an object." }, "cols": 2, "rows": 5 } [/block]
[block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "View", "1-0": "Edit", "2-0": "EditWithAccessEdit", "3-0": "Blocked", "3-1": "Apply when a subject is to be explicitly denied access to an object.\n\nCan only be used when setting Individual and Group permissions. **Not applicable when setting Team permissions**.", "0-1": "Apply when a subject is to be granted read-only permission to an object.", "4-0": "Null", "1-1": "Apply when a subject is to be granted editing rights to an object.", "2-1": "Apply when a subject is to be granted editing rights to an object, but this option also grants publishing rights.", "4-1": "Apply to reset subject's permissions to an object." }, "cols": 2, "rows": 5 } [/block]
{"_id":"5980046f93b4520014f56e8a","project":"5783990d5cbce30e0074e144","version":"5783990d5cbce30e0074e145","category":"57848e0eb3a5402400fee911","user":"5492aa57f0d1810b0066005f","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-01T04:32:47.737Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"Advanced\",\n    \"2-0\": \"Clients\",\n    \"6-0\": \"Delivery\",\n    \"7-0\": \"DBConnections\",\n    \"15-0\": \"LoginAs\",\n    \"20-0\": \"Presentations\",\n    \"21-0\": \"SaaS\",\n    \"22-0\": \"UpdateAndWarmup\",\n    \"23-0\": \"UpdateAndWarmupHourly\",\n    \"24-0\": \"UpdateAndWarmupMinute\",\n    \"0-1\": \"Enable or disable advanced analytics options (calculations, drill down, annotations, data blending).\",\n    \"2-1\": \"Enable or disable the ability to manage clients in a team.\",\n    \"6-1\": \"Enable or disable the ability to create schedule emails.\",\n    \"7-1\": \"Enable or disable the ability to create DB integrations.\",\n    \"15-1\": \"Enable or disable the ability to  login under other user accounts into the app (except admin accounts).\",\n    \"20-1\": \"Enable or disable the ability to see the Presentation section in the navigation pane and create presentations.\",\n    \"21-1\": \"Enable or disable the ability to create SaaS integrations.\",\n    \"22-1\": \"Enable or disable the ability to update datasets by shedule in background.\",\n    \"23-1\": \"Enable or disable the ability to set hourly dataset refresh.\",\n    \"24-1\": \"Enable or disable the ability to set minutely DB dataset refresh.\",\n    \"8-0\": \"DefaultMaxUsersInGroup\",\n    \"8-1\": \"The maximum number of users in group by default.\",\n    \"1-0\": \"Branding\",\n    \"9-0\": \"DynamicFiltering\",\n    \"12-0\": \"Export\",\n    \"12-1\": \"Enable or disable the ability to export infographics.\",\n    \"11-0\": \"EnableAggregateTimelines\",\n    \"11-1\": \"Enable or disable the ability to  aggregate timelines.\",\n    \"14-0\": \"GroupAdmin\",\n    \"14-1\": \"Enable or disable the ability to  create a group admin in a team.\",\n    \"13-0\": \"Folders\",\n    \"13-1\": \"Enable or disable the ability to create folders in library.\",\n    \"10-0\": \"EditXML\",\n    \"10-1\": \"Enable or disable the ability to edit datasets in the XML format.\",\n    \"3-0\": \"CloudIntegrationPoolSize\",\n    \"3-1\": \"This is the max number of parallel requests, which can becaused by the updating/creating of one data source. If the SaaS connector for the update needs more requests, then requests will organize in groups of N requests and will queue until all requests from the previous group are performed.\",\n    \"4-0\": \"CustomObjectSort\",\n    \"4-1\": \"Enable or disable the ability to custom sort of objects.\",\n    \"16-0\": \"ManualInput\",\n    \"16-1\": \"Enable or disable the ability to create charts based on the manually inputted data.\",\n    \"17-0\": \"MaxExportFileSize\",\n    \"17-1\": \"The maximum size of a file (MB) to which data from a raw table chart couldbe exported.\",\n    \"18-0\": \"MaxWarmup\",\n    \"18-1\": \"The maximum number of reports, dashboards and presentations, for which a warmup feature can be enabled. By default it’s set to 5.\",\n    \"19-0\": \"NavigatorEmbedding\",\n    \"19-1\": \"Enable or disable the ability to get an embed code for dashboards, reports, presentations and navigator of Slemma.\",\n    \"25-0\": \"WhiteLabel\",\n    \"25-1\": \"Enable or disable the ability to see additional settings under the 'Team settings' tab, and to customize the URL, name and other parts of the application.\",\n    \"h-2\": \"Type\",\n    \"25-2\": \"Boolean\",\n    \"7-2\": \"Boolean\",\n    \"21-2\": \"Boolean\",\n    \"15-2\": \"Boolean\",\n    \"20-2\": \"Boolean\",\n    \"16-2\": \"Boolean\",\n    \"10-2\": \"Boolean\",\n    \"4-2\": \"Boolean\",\n    \"2-2\": \"Boolean\",\n    \"13-2\": \"Boolean\",\n    \"11-2\": \"Boolean\",\n    \"22-2\": \"Boolean\",\n    \"23-2\": \"Boolean\",\n    \"24-2\": \"Boolean\",\n    \"14-2\": \"Boolean\",\n    \"5-2\": \"Boolean\",\n    \"19-2\": \"Boolean\",\n    \"1-2\": \"Boolean\",\n    \"9-2\": \"Boolean\",\n    \"5-0\": \"DashboardTemplating\",\n    \"17-2\": \"Integer\",\n    \"18-2\": \"Integer\",\n    \"3-2\": \"Integer\",\n    \"8-2\": \"Integer\",\n    \"6-2\": \"Boolean\",\n    \"12-2\": \"Boolean\",\n    \"0-2\": \"Boolean\",\n    \"5-1\": \"Enable or disable the ability to create templates of dashboards.\",\n    \"1-1\": \"Enable or disable the ability to customize the main aspects of the application appearance.\",\n    \"9-1\": \"Enable or disable the ability to dynamic filtering of the data.\"\n  },\n  \"cols\": 3,\n  \"rows\": 26\n}\n[/block]","excerpt":"Possible values for Team Features Enum","slug":"team-features","type":"basic","title":"Team Features","__v":0,"parentDoc":null,"childrenPages":[]}

Team Features

Possible values for Team Features Enum

[block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "Advanced", "2-0": "Clients", "6-0": "Delivery", "7-0": "DBConnections", "15-0": "LoginAs", "20-0": "Presentations", "21-0": "SaaS", "22-0": "UpdateAndWarmup", "23-0": "UpdateAndWarmupHourly", "24-0": "UpdateAndWarmupMinute", "0-1": "Enable or disable advanced analytics options (calculations, drill down, annotations, data blending).", "2-1": "Enable or disable the ability to manage clients in a team.", "6-1": "Enable or disable the ability to create schedule emails.", "7-1": "Enable or disable the ability to create DB integrations.", "15-1": "Enable or disable the ability to login under other user accounts into the app (except admin accounts).", "20-1": "Enable or disable the ability to see the Presentation section in the navigation pane and create presentations.", "21-1": "Enable or disable the ability to create SaaS integrations.", "22-1": "Enable or disable the ability to update datasets by shedule in background.", "23-1": "Enable or disable the ability to set hourly dataset refresh.", "24-1": "Enable or disable the ability to set minutely DB dataset refresh.", "8-0": "DefaultMaxUsersInGroup", "8-1": "The maximum number of users in group by default.", "1-0": "Branding", "9-0": "DynamicFiltering", "12-0": "Export", "12-1": "Enable or disable the ability to export infographics.", "11-0": "EnableAggregateTimelines", "11-1": "Enable or disable the ability to aggregate timelines.", "14-0": "GroupAdmin", "14-1": "Enable or disable the ability to create a group admin in a team.", "13-0": "Folders", "13-1": "Enable or disable the ability to create folders in library.", "10-0": "EditXML", "10-1": "Enable or disable the ability to edit datasets in the XML format.", "3-0": "CloudIntegrationPoolSize", "3-1": "This is the max number of parallel requests, which can becaused by the updating/creating of one data source. If the SaaS connector for the update needs more requests, then requests will organize in groups of N requests and will queue until all requests from the previous group are performed.", "4-0": "CustomObjectSort", "4-1": "Enable or disable the ability to custom sort of objects.", "16-0": "ManualInput", "16-1": "Enable or disable the ability to create charts based on the manually inputted data.", "17-0": "MaxExportFileSize", "17-1": "The maximum size of a file (MB) to which data from a raw table chart couldbe exported.", "18-0": "MaxWarmup", "18-1": "The maximum number of reports, dashboards and presentations, for which a warmup feature can be enabled. By default it’s set to 5.", "19-0": "NavigatorEmbedding", "19-1": "Enable or disable the ability to get an embed code for dashboards, reports, presentations and navigator of Slemma.", "25-0": "WhiteLabel", "25-1": "Enable or disable the ability to see additional settings under the 'Team settings' tab, and to customize the URL, name and other parts of the application.", "h-2": "Type", "25-2": "Boolean", "7-2": "Boolean", "21-2": "Boolean", "15-2": "Boolean", "20-2": "Boolean", "16-2": "Boolean", "10-2": "Boolean", "4-2": "Boolean", "2-2": "Boolean", "13-2": "Boolean", "11-2": "Boolean", "22-2": "Boolean", "23-2": "Boolean", "24-2": "Boolean", "14-2": "Boolean", "5-2": "Boolean", "19-2": "Boolean", "1-2": "Boolean", "9-2": "Boolean", "5-0": "DashboardTemplating", "17-2": "Integer", "18-2": "Integer", "3-2": "Integer", "8-2": "Integer", "6-2": "Boolean", "12-2": "Boolean", "0-2": "Boolean", "5-1": "Enable or disable the ability to create templates of dashboards.", "1-1": "Enable or disable the ability to customize the main aspects of the application appearance.", "9-1": "Enable or disable the ability to dynamic filtering of the data." }, "cols": 3, "rows": 26 } [/block]
[block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "Advanced", "2-0": "Clients", "6-0": "Delivery", "7-0": "DBConnections", "15-0": "LoginAs", "20-0": "Presentations", "21-0": "SaaS", "22-0": "UpdateAndWarmup", "23-0": "UpdateAndWarmupHourly", "24-0": "UpdateAndWarmupMinute", "0-1": "Enable or disable advanced analytics options (calculations, drill down, annotations, data blending).", "2-1": "Enable or disable the ability to manage clients in a team.", "6-1": "Enable or disable the ability to create schedule emails.", "7-1": "Enable or disable the ability to create DB integrations.", "15-1": "Enable or disable the ability to login under other user accounts into the app (except admin accounts).", "20-1": "Enable or disable the ability to see the Presentation section in the navigation pane and create presentations.", "21-1": "Enable or disable the ability to create SaaS integrations.", "22-1": "Enable or disable the ability to update datasets by shedule in background.", "23-1": "Enable or disable the ability to set hourly dataset refresh.", "24-1": "Enable or disable the ability to set minutely DB dataset refresh.", "8-0": "DefaultMaxUsersInGroup", "8-1": "The maximum number of users in group by default.", "1-0": "Branding", "9-0": "DynamicFiltering", "12-0": "Export", "12-1": "Enable or disable the ability to export infographics.", "11-0": "EnableAggregateTimelines", "11-1": "Enable or disable the ability to aggregate timelines.", "14-0": "GroupAdmin", "14-1": "Enable or disable the ability to create a group admin in a team.", "13-0": "Folders", "13-1": "Enable or disable the ability to create folders in library.", "10-0": "EditXML", "10-1": "Enable or disable the ability to edit datasets in the XML format.", "3-0": "CloudIntegrationPoolSize", "3-1": "This is the max number of parallel requests, which can becaused by the updating/creating of one data source. If the SaaS connector for the update needs more requests, then requests will organize in groups of N requests and will queue until all requests from the previous group are performed.", "4-0": "CustomObjectSort", "4-1": "Enable or disable the ability to custom sort of objects.", "16-0": "ManualInput", "16-1": "Enable or disable the ability to create charts based on the manually inputted data.", "17-0": "MaxExportFileSize", "17-1": "The maximum size of a file (MB) to which data from a raw table chart couldbe exported.", "18-0": "MaxWarmup", "18-1": "The maximum number of reports, dashboards and presentations, for which a warmup feature can be enabled. By default it’s set to 5.", "19-0": "NavigatorEmbedding", "19-1": "Enable or disable the ability to get an embed code for dashboards, reports, presentations and navigator of Slemma.", "25-0": "WhiteLabel", "25-1": "Enable or disable the ability to see additional settings under the 'Team settings' tab, and to customize the URL, name and other parts of the application.", "h-2": "Type", "25-2": "Boolean", "7-2": "Boolean", "21-2": "Boolean", "15-2": "Boolean", "20-2": "Boolean", "16-2": "Boolean", "10-2": "Boolean", "4-2": "Boolean", "2-2": "Boolean", "13-2": "Boolean", "11-2": "Boolean", "22-2": "Boolean", "23-2": "Boolean", "24-2": "Boolean", "14-2": "Boolean", "5-2": "Boolean", "19-2": "Boolean", "1-2": "Boolean", "9-2": "Boolean", "5-0": "DashboardTemplating", "17-2": "Integer", "18-2": "Integer", "3-2": "Integer", "8-2": "Integer", "6-2": "Boolean", "12-2": "Boolean", "0-2": "Boolean", "5-1": "Enable or disable the ability to create templates of dashboards.", "1-1": "Enable or disable the ability to customize the main aspects of the application appearance.", "9-1": "Enable or disable the ability to dynamic filtering of the data." }, "cols": 3, "rows": 26 } [/block]