Jump to

• Request
• Response
• Examples

Get a capacity category

get

/rest/ofscMetadata/v1/capacityCategories/{label}

This operation retrieves the details about the specified capacity category. The operation also returns all translations related to the name of the capacity category. The response contains the translations for the user's language in the translation structure and in the 'name' entity field.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the capacity category.

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root 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
  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.
• languageISO: string
  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)
• name(required): string

{
    "properties":{
        "language":{
            "description":"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.",
            "type":"string"
        },
        "languageISO":{
            "description":"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)",
            "type":"string"
        },
        "name":{
            "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

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get a capacity category 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/test1
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 15:01: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.

{
   "label": "test1",
   "name": "4534534",
   "active": false,
   "workSkills": [   {
      "label": "IN",
      "ratio": 11,
      "startDate": "2017-08-23"
   }],
   "workSkillGroups": [   {
      "label": "disconnect",
      "startDate": "2017-08-23",
      "links": [      {
         "rel": "canonical",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/disconnect"
      }]
   }],
   "timeSlots": [{"label": "08-10"}],
   "translations":    [
            {
         "language": "en",
         "name": "4534534",
         "languageISO": "en-US"
      },
            {
         "language": "es",
         "name": "4534534",
         "languageISO": "es-ES"
      }
   ],
   "links":    [
            {
         "rel": "canonical",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/capacityCategories/test1"
      },
            {
         "rel": "describedby",
         "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/capacityCategories"
      }
   ]
}

Back to Top