Get capacity categories

get

/rest/ofscMetadata/v1/capacityCategories

This operation retrieves a collection of capacity categories.

Request

Query Parameters
  • The number of items to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : CapacityCategories
Type: object
The collection of capacity categories.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Capacity Category
Type: object
Title: Capacity Category
Show Source
  • Title: Active
    Contains one of the following values: true or false.

    If true, then the active capacity categories are returned. If false, then the inactive capacity categories are returned. The default value is true.

  • Title: Label
    Minimum Length: 1
    Maximum Length: 40
    The label of the capacity category. The label is returned by the GET operation and is ignored in the PUT operation.
  • Title: Name
    Minimum Length: 1
    Maximum Length: 5000
    The name of the capacity category in the user's language. The name is returned by the GET operation and is ignored in the PUT operation.
  • Time Slots
    Title: Time Slots
    The array of time slots objects. It is optional for the PUT operation.
  • Translations
    Title: Translations
    The list of translations associated with the name of the capacity category.
    • The translations parameter is required in the PUT method for creating a capacity category, but the parameter is optional for updating a capacity category.
    • If the parameter is not specified, then the translations in the response are not changed.
    • The translation for the 'name' attribute must not be empty atleast for the default language.
  • Work Skill Groups
    Title: Work Skill Groups
    The array of work skill group objects. It is optional for the PUT operation.
  • Work Skills
    Title: Work Skills
    The array of work skill objects. It is optional for the PUT operation.
Nested Schema : Time Slots
Type: array
Title: Time Slots
The array of time slots objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translations
Type: array
Title: Translations
The list of translations associated with the name of the capacity category.
  • The translations parameter is required in the PUT method for creating a capacity category, but the parameter is optional for updating a capacity category.
  • If the parameter is not specified, then the translations in the response are not changed.
  • The translation for the 'name' attribute must not be empty atleast for the default language.
Show Source
Nested Schema : Work Skill Groups
Type: array
Title: Work Skill Groups
The array of work skill group objects. It is optional for the PUT operation.
Show Source
Nested Schema : Work Skills
Type: array
Title: Work Skills
The array of work skill objects. It is optional for the PUT operation.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : Translation
Type: object
Show Source
  • This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
  • This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to get a collection of capacity categories by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscMetadata/v1/capacityCategories?offset=2&limit=1
Connection: close
Accept-Encoding: gzip,deflate
Authorization: Basic bXlyb290QHFhNTUwMzox
Host: <instance_name>.etadirect.com
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 23 Aug 2017 14:58:16 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Credentials: true
Strict-Transport-Security: max-age=31536000; includeSubDomains;

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
   "hasMore": true,
   "totalResults": 8,
   "limit": 1,
   "offset": 2,
   "items": [   {
      "label": "UP",
      "name": "Upgrade",
      "active": true,
      "workSkills": [      {
         "label": "UP",
         "ratio": 1,
         "startDate": "2000-01-01"
      }],
      "workSkillGroups": [],
      "timeSlots":       [
         {"label": "08-10"},
         {"label": "10-12"},
         {"label": "13-15"},
         {"label": "15-17"}
      ],
      "translations":       [
                  {
            "language": "en",
            "name": "Upgrade",
            "languageISO": "en-US"
         },
                  {
            "language": "es",
            "name": "Upgrade",
            "languageISO": "es-ES"
         },
                  {
            "language": "fr",
            "name": "Upgrade",
            "languageISO": "fr-FR"
         },
                  {
            "language": "nl",
            "name": "Upgrade",
            "languageISO": "nl-NL"
         },
                  {
            "language": "de",
            "name": "Upgrade",
            "languageISO": "de-DE"
         },
                  {
            "language": "ro",
            "name": "Upgrade",
            "languageISO": "ro-RO"
         },
                  {
            "language": "ru",
            "name": "????????????????????????",
            "languageISO": "ru-RU"
         },
                  {
            "language": "br",
            "name": "Upgrade",
            "languageISO": "pt-BR"
         }
      ],
      "links":       [
                  {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityCategories/UP"
         },
                  {
            "rel": "describedby",
            "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/capacityCategories"
         }
      ]
   }],
   "links":    [
            {
         "rel": "canonical",
         "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityCategories?limit=1&offset=2"
      },
            {
         "rel": "prev",
         "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityCategories?offset=1"
      },
            {
         "rel": "next",
         "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/capacityCategories?offset=3"
      },
            {
         "rel": "describedby",
         "href": "https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/capacityCategories"
      }
   ]
}
Back to Top