List collections

Create a document collection

get
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections

Query Parameters

sortstring

Sorts a list of collections. Supported sort attributes are:

  • created_at
  • updated_at
  • name
page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter documents returned in the response.

Show Child Parameters

Response

200 application/json

The collection has been created

ListCollectionResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

a document collection

Show Child Parameters
get/collections
 
200 application/json

Create collection

Create a document collection

post
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections

Body

application/json

collection creation

CreateCollectionPayload

payload to create the document collection

namestringrequired

Response

application/json

The collection has been created

Document Collection

a document collection

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

Example:my document collection

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/collections

Body

{ "name": "name" }
 
application/json

Get document collection

Get document collection

get
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections/{collectionId}

Path Parameters

collectionIdstring(uuid)required

Targeted collection

Example:bb84c46a-432d-4314-81e4-478614a52dcb

Response

application/json

Document collection

Document Collection

a document collection

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

Example:my document collection

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/collections/{collectionId}
 
application/json

Create or Update collection

Create or Update the document collection. collectionId must be globally unique. A collectionId of a different kind (service/portal) must not already exist.

put
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections/{collectionId}

Path Parameters

collectionIdstring(uuid)required

Targeted collection

Example:bb84c46a-432d-4314-81e4-478614a52dcb

Body

application/json

collection put

Document Collection

a document collection

namestringrequired

Example:my document collection

Response

application/json

The document collection has been updated

Document Collection

a document collection

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

Example:my document collection

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/collections/{collectionId}

Body

{ "name": "my document collection" }
 
application/json

Update collection

Update the document collection

patch
http://documenthub.documenthub.svc.cluster.local:4400/v2/collections/{collectionId}

Path Parameters

collectionIdstring(uuid)required

Targeted collection

Example:bb84c46a-432d-4314-81e4-478614a52dcb

Body

application/json

collection update

UpdateCollectionPayload

payload to update the document collection

namestringrequired

Response

application/json

The document collection has been created

Document Collection

a document collection

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

Example:my document collection

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/collections/{collectionId}

Body

{ "name": "name" }
 
application/json