1. REST API for Oracle Fusion Field Service Cloud Service
  2. Tasks
  3. Metadata
  4. Capacity Categories

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
Body ()
The capacity category object to be created or updated.
Root 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
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root 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

201 Response

This section describes the 201 status response for this operation.
Body ()
Root 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
Show Source
Back to Top

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"
        }
    ]
}
Back to Top