Items
The Item itself: what it is, where it is, who can open it, and what you can do with it.
The service.
application/json- response
@meta?The name and version of the service that answered.
curl -X GET "https://platform.example.com/api/item"{ "@meta": {}}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
The Item and its routes.
application/json- response
@meta?The name and version of the service that answered.
type?stringThe kind of Item.
routes?array<string>The endpoints that the Item has.
data?The Item.
curl -X GET "https://platform.example.com/api/item/$ITEM_ID" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "type": "string", "routes": [ "string" ], "data": {}}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
The answer.
application/json- response
@meta?The name and version of the service that answered.
type?unknownroutes?unknowndata?unknowncurl -X GET "https://platform.example.com/api/item/$ITEM_ID/actions" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "type": null, "routes": null, "data": null}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
The Item.
application/json- response
@meta?The name and version of the service that answered.
data?The Item, with children for a folder.
curl -X GET "https://platform.example.com/api/item/$ITEM_ID/details" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "data": {}}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
The path.
application/json- response
@meta?The name and version of the service that answered.
data?array<>curl -X GET "https://platform.example.com/api/item/$ITEM_ID/location" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "data": [ {} ]}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
The answer.
application/json- response
@meta?The name and version of the service that answered.
data?unknowncurl -X GET "https://platform.example.com/api/item/$ITEM_ID/permission" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "data": null}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
application/json- body
permission?The permission to set: who can open the Item and with which role.
recursive?booleanSet it on everything inside a folder too.
The id of the Item.
application/json- response
@meta?The name and version of the service that answered.
data?stringcurl -X PUT "https://platform.example.com/api/item/$ITEM_ID/permission" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "permission": {}, "recursive": false}'{ "@meta": {}, "data": "string"}AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
id*stringThe id of the Item.
keyword?stringWords to look for.
excludeUsers?stringexcludeGroups?stringskip?integerHow many to skip.
0limit?integerHow many to return.
100The answer.
application/json- response
@meta?The name and version of the service that answered.
data?unknowncurl -X GET "https://platform.example.com/api/item/$ITEM_ID/sharing/targets" \ -H "Authorization: Bearer $TOKEN"{ "@meta": {}, "data": null}