Document Store

Get a Document by name

Get a Document by name.

get/v1/docStore/name/{name}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/docStore/name/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

Name of the Document

Query parameters

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

The Document

idstring uuid
namestring required
displayNamestring
fullyQualifiedNamestring required
descriptionstring
entityTypestring required
dataData required
updatedAtinteger
updatedBystring
impersonatedBystring
versionnumber double
hrefstring uri
provider'system' | 'user' | 'automation'
extensionobject
deletedboolean
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.