Edit

Collection

This endpoint is used to manager collection inside an organization.

Entity fields:

Path
Type
Description

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

get

Returns the relationship collection

Path parameters
organizationIdstringRequired

organization Identifier

Query parameters
filter[collection]stringOptional

Filters the collection of collection using a 'disjoint' RSQL expression

page[number]integer · int32Optional

Number of pages to return. Can be used with page[size]

page[size]integer · int32Optional

Number of elements per page. Can be used with page[number]

page[offset]integer · int32Optional

Offset from 0 to start paginating. Can be used with page[limit]

page[limit]integer · int32Optional

Maximum number of items to return. Can be used with page[offset]

page[totals]stringOptional

For requesting total pages/records be included in the response page meta data

Responses
200

Successful response

application/vnd.api+json
get
/organization/{organizationId}/collection
GET /api/v1/organization/{organizationId}/collection HTTP/1.1
Host: 
Accept: */*
200

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": {}
    }
  ]
}
post

Creates an item of type collection and adds it to collection

Path parameters
organizationIdstringRequired

organization Identifier

Body
Responses
201

Successful response

application/vnd.api+json
post
/organization/{organizationId}/collection
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": {}
    }
  ]
}
201

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": {}
    }
  ]
}
get

Returns an instance of type collection

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

Query parameters
Responses
200

Successful response

application/vnd.api+json
get
/organization/{organizationId}/collection/{collectionId}
GET /api/v1/organization/{organizationId}/collection/{collectionId} HTTP/1.1
Host: 
Accept: */*
200

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": {}
    }
  ]
}
delete

Deletes an instance of type collection

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

Responses
204

Successful response

No content
delete
/organization/{organizationId}/collection/{collectionId}
DELETE /api/v1/organization/{organizationId}/collection/{collectionId} HTTP/1.1
Host: 
Accept: */*
204

Successful response

No content
patch

Modifies an instance of type collection

Path parameters
organizationIdstringRequired

organization Identifier

collectionIdstringRequired

collection Identifier

Body
Responses
204

Successful response

No content
patch
/organization/{organizationId}/collection/{collectionId}
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": {}
    }
  ]
}
204

Successful response

No content
PreviousAgentNextCollection Item

Last updated

Was this helpful?