Jump to

• Request
• Response
• Examples

Get capacity categories

get

/rest/ofscMetadata/v1/capacityCategories

This operation retrieves a collection of capacity categories.

Request

Query Parameters

• limit: integer
  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.
• offset: integer
  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

• application/json
• application/schema+json

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

• items: array items
• limit: integer
  The limit value specified in the request. If the value is not specified in the request or if the specified value is greater than 100, then it defaults to 100.
• offset: integer
  The offset value specified in the request.
• totalResults: integer
  The total number of capacity categories in the response.

{
    "description":"The collection of capacity categories.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CapacityCategory"
            }
        },
        "totalResults":{
            "description":"The total number of capacity categories in the response.",
            "type":"integer"
        },
        "offset":{
            "description":"The offset value specified in the request.",
            "type":"integer"
        },
        "limit":{
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is greater than 100, then it defaults to 100.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Capacity Category
  Title: Capacity Category

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CapacityCategory"
    }
}

Nested Schema : Capacity Category

Type: object

Title: Capacity Category

Show Source

• active(required): boolean
  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.

• label: string
  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.
• name: string
  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.
• timeSlots: array Time Slots
  Title: Time Slots

  The array of time slots objects. It is optional for the PUT operation.
• translations: array 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.
• workSkillGroups: array Work Skill Groups
  Title: Work Skill Groups

  The array of work skill group objects. It is optional for the PUT operation.
• workSkills: array Work Skills
  Title: Work Skills

  The array of work skill objects. It is optional for the PUT operation.

{
    "type":"object",
    "title":"Capacity Category",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Label",
            "description":"The label of the capacity category. The label is returned by the GET operation and is ignored in the PUT operation."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":5000,
            "title":"Name",
            "description":"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."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the active capacity categories are returned. If false, then the inactive capacity categories are returned. The default value is true.</p>"
        },
        "workSkills":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the work skill.",
                        "type":"string"
                    },
                    "ratio":{
                        "description":"The ratio used for assigning the work skill to a resource.",
                        "type":"integer",
                        "minimum":1,
                        "maximum":100
                    },
                    "startDate":{
                        "description":"The start date of the work skill. It is ignored in the PUT operation.",
                        "type":"string",
                        "format":"date"
                    }
                },
                "required":[
                    "label",
                    "ratio"
                ]
            },
            "title":"Work Skills",
            "description":"The array of work skill objects. It is optional for the PUT operation."
        },
        "workSkillGroups":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the work skill group.",
                        "type":"string"
                    },
                    "startDate":{
                        "description":"The start date of the work skill group. It is ignored in the PUT operation.",
                        "type":"string",
                        "format":"date"
                    }
                },
                "required":[
                    "label"
                ]
            },
            "title":"Work Skill Groups",
            "description":"The array of work skill group objects. It is optional for the PUT operation."
        },
        "timeSlots":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the time slot.",
                        "type":"string"
                    }
                },
                "required":[
                    "label"
                ]
            },
            "title":"Time Slots",
            "description":"The array of time slots objects. It is optional for the PUT operation."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The list of translations associated with the name of the capacity category.<ul><li>The translations parameter is required in the PUT method for creating a capacity category, but the parameter is optional for updating a capacity category.</li><li>If the parameter is not specified, then the translations in the response are not changed.</li><li>The translation for the 'name' attribute must not be empty atleast for the default language.</li></ul>"
        }
    },
    "required":[
        "active"
    ]
}

Nested Schema : Time Slots

Type: array

Title: Time Slots

The array of time slots objects. It is optional for the PUT operation.

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the time slot.",
                "type":"string"
            }
        },
        "required":[
            "label"
        ]
    },
    "title":"Time Slots",
    "description":"The array of time slots objects. It is optional for the PUT operation."
}

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

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The list of translations associated with the name of the capacity category.<ul><li>The translations parameter is required in the PUT method for creating a capacity category, but the parameter is optional for updating a capacity category.</li><li>If the parameter is not specified, then the translations in the response are not changed.</li><li>The translation for the 'name' attribute must not be empty atleast for the default language.</li></ul>"
}

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

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the work skill group.",
                "type":"string"
            },
            "startDate":{
                "description":"The start date of the work skill group. It is ignored in the PUT operation.",
                "type":"string",
                "format":"date"
            }
        },
        "required":[
            "label"
        ]
    },
    "title":"Work Skill Groups",
    "description":"The array of work skill group objects. It is optional for the PUT operation."
}

Nested Schema : Work Skills

Type: array

Title: Work Skills

The array of work skill objects. It is optional for the PUT operation.

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the work skill.",
                "type":"string"
            },
            "ratio":{
                "description":"The ratio used for assigning the work skill to a resource.",
                "type":"integer",
                "minimum":1,
                "maximum":100
            },
            "startDate":{
                "description":"The start date of the work skill. It is ignored in the PUT operation.",
                "type":"string",
                "format":"date"
            }
        },
        "required":[
            "label",
            "ratio"
        ]
    },
    "title":"Work Skills",
    "description":"The array of work skill objects. It is optional for the PUT operation."
}

Nested Schema : items

Type: object

Show Source

• label(required): string
  The label of the time slot.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the time slot.",
            "type":"string"
        }
    },
    "required":[
        "label"
    ]
}

Nested Schema : Translation

Type: object

Show Source

• language(required): string
  The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').

  See Supported Language Codes to view the values that are supported.

• languageISO: string
  The ISO language code (for example, 'en-US').
• name(required): string
  The specified name of the property translated to the language code available in the system.

{
    "properties":{
        "language":{
            "description":"The language code of the translated text. The code in the response is two characters long (for example, 'en', 'es').<p>See <a href='OFSC_Supported_Language_Codes.html'>Supported Language Codes</a> to view the values that are supported.</p> ",
            "type":"string"
        },
        "languageISO":{
            "description":"The ISO language code (for example, 'en-US').",
            "type":"string"
        },
        "name":{
            "description":"The specified name of the property translated to the language code available in the system.",
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Nested Schema : items

Type: object

Show Source

• label(required): string
  The label of the work skill group.
• startDate: string(date)
  The start date of the work skill group. It is ignored in the PUT operation.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the work skill group.",
            "type":"string"
        },
        "startDate":{
            "description":"The start date of the work skill group. It is ignored in the PUT operation.",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "label"
    ]
}

Nested Schema : items

Type: object

Show Source

• label(required): string
  The label of the work skill.
• ratio(required): integer
  Minimum Value: 1

  Maximum Value: 100

  The ratio used for assigning the work skill to a resource.
• startDate: string(date)
  The start date of the work skill. It is ignored in the PUT operation.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the work skill.",
            "type":"string"
        },
        "ratio":{
            "description":"The ratio used for assigning the work skill to a resource.",
            "type":"integer",
            "minimum":1,
            "maximum":100
        },
        "startDate":{
            "description":"The start date of the work skill. It is ignored in the PUT operation.",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "label",
        "ratio"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Error response

Show Source

• detail: string
  The detailed information about the error.
• status: string
  The HTTP status code.
• title: string
  The summary of the error message.
• type: string
  The URL of the page containing the error details.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the page containing the error details."
        },
        "title":{
            "type":"string",
            "description":"The summary of the error message."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code."
        },
        "detail":{
            "type":"string",
            "description":"The detailed information about the error."
        }
    },
    "description":"Error response"
}

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>.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityCategories/UP"
         },
                  {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/capacityCategories"
         }
      ]
   }],
   "links":    [
            {
         "rel": "canonical",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityCategories?limit=1&offset=2"
      },
            {
         "rel": "prev",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityCategories?offset=1"
      },
            {
         "rel": "next",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityCategories?offset=3"
      },
            {
         "rel": "describedby",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/capacityCategories"
      }
   ]
}

Back to Top