API

Quality management APIs

GET quality/document-collections/{documentCollectionId}

Gets a document collection

HTTP method GET
URI https://api.rambase.net/quality/document-collections/{documentCollectionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {documentCollectionId} Identifier of the document collection
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6257, version 17

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<DocumentCollection>
2
     <DocumentCollectionId
DocumentCollectionId

Identifier of the document collection

>{Integer}</DocumentCollectionId>
3
     <Status
Status

Status of document collection

Possible domain values can be found here

>{Integer}</Status>
4
     <Title
Title

Title of document collection

>{String}</Title>
5
     <Description
Description

Description of the document collection

>{String}</Description>
6
     <CreatedAt
CreatedAt

Automatically generated timestamp when creating a document collection

>{Datetime}</CreatedAt>
7
     <UpdatedAt
UpdatedAt

Automatically generated timestamp when a document collection is updated

>{Datetime}</UpdatedAt>
8
     <NumberOfQualityDocuments
NumberOfQualityDocuments

Number of documents contained in this collection

>{Integer}</NumberOfQualityDocuments>
9
     <Usage
Usage

This field is greyed out because it is an expandable field. You have to add $expand=Usage in your request URI to get this field

>
10
          <NumberOfCompetenceProfiles
NumberOfCompetenceProfiles

Number of competence profiles that are using this document collection

This field is greyed out because it is an expandable field. You have to add $expand=Usage in your request URI to get this field

>{Integer}</NumberOfCompetenceProfiles>
11
     </Usage>
12
</DocumentCollection>
1
{
2
     "documentCollection": {
3
          "documentCollectionId
DocumentCollectionId

Identifier of the document collection

": "{Integer}",
4
          "status
Status

Status of document collection

Possible domain values can be found here

": "{Integer}",
5
          "title
Title

Title of document collection

": "{String}",
6
          "description
Description

Description of the document collection

": "{String}",
7
          "createdAt
CreatedAt

Automatically generated timestamp when creating a document collection

": "{Datetime}",
8
          "updatedAt
UpdatedAt

Automatically generated timestamp when a document collection is updated

": "{Datetime}",
9
          "numberOfQualityDocuments
NumberOfQualityDocuments

Number of documents contained in this collection

": "{Integer}",
10
          "usage
Usage

This field is greyed out because it is an expandable field. You have to add $expand=Usage in your request URI to get this field

": {
11
               "numberOfCompetenceProfiles
NumberOfCompetenceProfiles

Number of competence profiles that are using this document collection

This field is greyed out because it is an expandable field. You have to add $expand=Usage in your request URI to get this field

": "{Integer}"
12
          }
13
     }
14
}

Possible error codes the response might return: