TMF667 v4 Document Management

GET List Documents

GET /document

Retrieves a list of Document entities. Attribute selection is enabled for first-level attributes and filtering is supported for name.

Parameters

• fields (query, string) fields for attribute selection. supported values- name, documentType, status, description, creationdate, lastupdate
• name (query, string) Name of the document
• offset (query, integer) Specifies the requested index for the start of the resources to be included in the response.
• pageLimit (query, integer) Specifies the requested number of the resources to be included in the response.
• pageInfo (query, boolean) Enables customer to get pageinformation with GET response.
• Authorization (header, string, required) Specifies the bearer token to use for the authentication of request.
• Namespace (header, string) Specifies the namespace to use with the URL path.
• Domain-Name (header, string, required) Specifies the domain name to use with the URL path received from the userinfo API.
• Version (header, string, required) Specifies the version to use with the URL path.

Responses

• 200 successfully retrieved the document list

  Media type: application/json. Schema: array of Document.

  Array of Document.

• 404 Resource not found.

  Media type: application/json. Schema: Error.

  Example

  code: NOT_FOUND
  reason: There are no matching resource.

• 500 Internal server error

  Media type: application/json. Schema: Error.

  Example

  code: "500"
  reason: Internal server error