Create or update a capacity category
put
/rest/ofscMetadata/v1/capacityCategories/{label}
This operation creates a new capacity category or updates an existing capacity category.
Request
Path Parameters
-
label(required): string
Minimum Length:
1Maximum Length:40The label of the capacity category.
The capacity category object to be created or updated.
Root Schema : Capacity Category
Type:
objectTitle:
Show Source
Capacity Category-
active(required):
boolean
Title:
ActiveContains 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:
LabelMinimum Length:1Maximum Length:40The label of the capacity category. The label is returned by the GET operation and is ignored in the PUT operation. -
name:
string
Title:
NameMinimum Length:1Maximum Length:5000The 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 SlotsThe array of time slots objects. It is optional for the PUT operation. -
translations:
array Translations
Title:
TranslationsThe 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 GroupsThe array of work skill group objects. It is optional for the PUT operation. -
workSkills:
array Work Skills
Title:
Work SkillsThe array of work skill objects. It is optional for the PUT operation.
Nested Schema : Time Slots
Type:
arrayTitle:
Time SlotsThe array of time slots objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translations
Type:
arrayTitle:
TranslationsThe list of translations associated with the name of the capacity category.
Show Source
- 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.
Nested Schema : Work Skill Groups
Type:
arrayTitle:
Work Skill GroupsThe array of work skill group objects. It is optional for the PUT operation.
Show Source
Nested Schema : Work Skills
Type:
arrayTitle:
Work SkillsThe array of work skill objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translation
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
label(required):
string
The label of the work skill.
-
ratio(required):
integer
Minimum Value:
1Maximum Value:100The 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.
Response
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : Capacity Category
Type:
objectTitle:
Show Source
Capacity Category-
active(required):
boolean
Title:
ActiveContains 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:
LabelMinimum Length:1Maximum Length:40The label of the capacity category. The label is returned by the GET operation and is ignored in the PUT operation. -
name:
string
Title:
NameMinimum Length:1Maximum Length:5000The 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 SlotsThe array of time slots objects. It is optional for the PUT operation. -
translations:
array Translations
Title:
TranslationsThe 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 GroupsThe array of work skill group objects. It is optional for the PUT operation. -
workSkills:
array Work Skills
Title:
Work SkillsThe array of work skill objects. It is optional for the PUT operation.
Nested Schema : Time Slots
Type:
arrayTitle:
Time SlotsThe array of time slots objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translations
Type:
arrayTitle:
TranslationsThe list of translations associated with the name of the capacity category.
Show Source
- 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.
Nested Schema : Work Skill Groups
Type:
arrayTitle:
Work Skill GroupsThe array of work skill group objects. It is optional for the PUT operation.
Show Source
Nested Schema : Work Skills
Type:
arrayTitle:
Work SkillsThe array of work skill objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translation
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
label(required):
string
The label of the work skill.
-
ratio(required):
integer
Minimum Value:
1Maximum Value:100The 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.
201 Response
This section describes the 201 status response for this operation.
Root Schema : Capacity Category
Type:
objectTitle:
Show Source
Capacity Category-
active(required):
boolean
Title:
ActiveContains 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:
LabelMinimum Length:1Maximum Length:40The label of the capacity category. The label is returned by the GET operation and is ignored in the PUT operation. -
name:
string
Title:
NameMinimum Length:1Maximum Length:5000The 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 SlotsThe array of time slots objects. It is optional for the PUT operation. -
translations:
array Translations
Title:
TranslationsThe 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 GroupsThe array of work skill group objects. It is optional for the PUT operation. -
workSkills:
array Work Skills
Title:
Work SkillsThe array of work skill objects. It is optional for the PUT operation.
Nested Schema : Time Slots
Type:
arrayTitle:
Time SlotsThe array of time slots objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translations
Type:
arrayTitle:
TranslationsThe list of translations associated with the name of the capacity category.
Show Source
- 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.
Nested Schema : Work Skill Groups
Type:
arrayTitle:
Work Skill GroupsThe array of work skill group objects. It is optional for the PUT operation.
Show Source
Nested Schema : Work Skills
Type:
arrayTitle:
Work SkillsThe array of work skill objects. It is optional for the PUT operation.
Show Source
Nested Schema : Translation
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
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.
Nested Schema : items
Type:
Show Source
object-
label(required):
string
The label of the work skill.
-
ratio(required):
integer
Minimum Value:
1Maximum Value:100The 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.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
objectError 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.
Examples
You can create or update capacity categories by submitting a PUT request on the REST resource. The following example shows how to create a capacity category by submitting a PUT request on the REST resource.
Example of Request Header
The following shows an example of the request header.
PUT /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 Request Body
The following example shows the contents of the request body in JSON format.
{
"active": true,
"workSkills": [
{
"label": "IN",
"ratio": 11
}
],
"workSkillGroups": [
{
"label": "disconnect"
}
],
"timeSlots": [
{
"label": "08-10"
}
],
"translations": [
{
"language": "en",
"name": "4534534"
},
{
"language": "es",
"name": "4534534"
}
]
} Example of Response Header
The following shows an example of the response header.
HTTP/1.1 201 Created Server: nginx Date: Wed, 23 Aug 2017 14:36:58 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": true,
"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"
}
]
}