Collection
This endpoint is used to manager collection inside an organization.
Entity fields:
data.type
string
Should be "step"
data.attributes.description
string
Collection description
data.attributes.name
string
Collection name
data.attributes.priority
int
Collection priority
Example:
POST /api/v1/organization/${ORGANIZATION_ID}/collection/
{
"data": {
"type": "collection",
"attributes": {
"description": "Sample Description",
"name": "Collection1",
"priority": 10,
}
}
Supported Operation
Returns the relationship collection
organization Identifier
Filters the collection of collection using a 'disjoint' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
GET /api/v1/organization/{organizationId}/collection HTTP/1.1
Host:
Accept: */*
Successful response
{
"data": [
{
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"priority": null,
"updatedBy": null,
"updatedDate": null
},
"relationships": {
"item": {
"data": [
null
]
},
"organization": {
"data": [
null
]
},
"reference": {
"data": [
null
]
}
}
}
],
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Creates an item of type collection and adds it to collection
organization Identifier
Successful response
POST /api/v1/organization/{organizationId}/collection HTTP/1.1
Host:
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 346
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"priority": null,
"updatedBy": null,
"updatedDate": null
},
"relationships": {
"item": {
"data": [
null
]
},
"organization": {
"data": [
null
]
},
"reference": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Successful response
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"priority": null,
"updatedBy": null,
"updatedDate": null
},
"relationships": {
"item": {
"data": [
null
]
},
"organization": {
"data": [
null
]
},
"reference": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Returns an instance of type collection
organization Identifier
collection Identifier
Successful response
GET /api/v1/organization/{organizationId}/collection/{collectionId} HTTP/1.1
Host:
Accept: */*
Successful response
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"priority": null,
"updatedBy": null,
"updatedDate": null
},
"relationships": {
"item": {
"data": [
null
]
},
"organization": {
"data": [
null
]
},
"reference": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Deletes an instance of type collection
organization Identifier
collection Identifier
Successful response
DELETE /api/v1/organization/{organizationId}/collection/{collectionId} HTTP/1.1
Host:
Accept: */*
Successful response
No content
Modifies an instance of type collection
organization Identifier
collection Identifier
Successful response
PATCH /api/v1/organization/{organizationId}/collection/{collectionId} HTTP/1.1
Host:
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 346
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"priority": null,
"updatedBy": null,
"updatedDate": null
},
"relationships": {
"item": {
"data": [
null
]
},
"organization": {
"data": [
null
]
},
"reference": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Successful response
No content
Last updated
Was this helpful?