Create or replace a work skill group

put

/rest/ofscMetadata/v1/workSkillGroups/{label}

This operation creates a work skill group resource or updates an existing one.

If the 'translation' parameter is not available for the update, then the translations are not changed; else all the translations are replaced by the structure from the request. The translations that are sent as entity fields are ignored.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 40
    The label of the work skill group.
Body ()
This section describes the request body parameters for this operation.
Root Schema : Work Skill Group
Type: object
Title: Work Skill Group
Show Source
  • Title: Active

    Contains one of the following values: true or false.

    If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true.

    Note: It is present for all work skill groups.

  • Title: Add to Capacity Category

    Contains one of the following values: true or false.

    If true, then the work skill group is added to the capacity category. By default, it is true.

    Note: This field is present for all work skill groups.

  • Title: Assign to Resource

    Contains one of the following values: true or false.

    If true, then the work skill group is assigned to the resource. By default, it is true.

    Note: This field is present for all work skill groups.

  • Title: Label
    Minimum Length: 1
    Maximum Length: 40
    The label of the work skill group.
  • Title: Name
    Minimum Length: 1
    Maximum Length: 5000
    The name of the work skill group in the user's language.
  • Translations
    Title: Translations
    The array of translation objects associated with the work skill group.
  • Work Skills
    Title: Work Skills
    The array of work skill objects associated with the work skill group.
Nested Schema : Translations
Type: array
Title: Translations
The array of translation objects associated with the work skill group.
Show Source
Nested Schema : Work Skills
Type: array
Title: Work Skills
The array of work skill objects associated with the work skill group.
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
  • The label of the work skill object.
  • Minimum Value: 1
    Maximum Value: 100
    The ratio used to assign the work skill group to a resource.
Back to Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation. This code is returned when a work skill group object is updated.
Body ()
Root Schema : Work Skill Group
Type: object
Title: Work Skill Group
Show Source
  • Title: Active

    Contains one of the following values: true or false.

    If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true.

    Note: It is present for all work skill groups.

  • Title: Add to Capacity Category

    Contains one of the following values: true or false.

    If true, then the work skill group is added to the capacity category. By default, it is true.

    Note: This field is present for all work skill groups.

  • Title: Assign to Resource

    Contains one of the following values: true or false.

    If true, then the work skill group is assigned to the resource. By default, it is true.

    Note: This field is present for all work skill groups.

  • Title: Label
    Minimum Length: 1
    Maximum Length: 40
    The label of the work skill group.
  • Title: Name
    Minimum Length: 1
    Maximum Length: 5000
    The name of the work skill group in the user's language.
  • Translations
    Title: Translations
    The array of translation objects associated with the work skill group.
  • Work Skills
    Title: Work Skills
    The array of work skill objects associated with the work skill group.
Nested Schema : Translations
Type: array
Title: Translations
The array of translation objects associated with the work skill group.
Show Source
Nested Schema : Work Skills
Type: array
Title: Work Skills
The array of work skill objects associated with the work skill group.
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
  • The label of the work skill object.
  • Minimum Value: 1
    Maximum Value: 100
    The ratio used to assign the work skill group to a resource.

201 Response

This section describes the 201 status response for this operation. This code is returned when a work skill group object is created.
Body ()
Root Schema : Work Skill Group
Type: object
Title: Work Skill Group
Show Source
  • Title: Active

    Contains one of the following values: true or false.

    If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true.

    Note: It is present for all work skill groups.

  • Title: Add to Capacity Category

    Contains one of the following values: true or false.

    If true, then the work skill group is added to the capacity category. By default, it is true.

    Note: This field is present for all work skill groups.

  • Title: Assign to Resource

    Contains one of the following values: true or false.

    If true, then the work skill group is assigned to the resource. By default, it is true.

    Note: This field is present for all work skill groups.

  • Title: Label
    Minimum Length: 1
    Maximum Length: 40
    The label of the work skill group.
  • Title: Name
    Minimum Length: 1
    Maximum Length: 5000
    The name of the work skill group in the user's language.
  • Translations
    Title: Translations
    The array of translation objects associated with the work skill group.
  • Work Skills
    Title: Work Skills
    The array of work skill objects associated with the work skill group.
Nested Schema : Translations
Type: array
Title: Translations
The array of translation objects associated with the work skill group.
Show Source
Nested Schema : Work Skills
Type: array
Title: Work Skills
The array of work skill objects associated with the work skill group.
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
  • The label of the work skill object.
  • Minimum Value: 1
    Maximum Value: 100
    The ratio used to assign the work skill group to a resource.

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 create or replace a work skill group 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/workSkillGroups/new_ws_group HTTP/1.0
Host: <instance_name>.etadirect.com 
Authorization: Basic c29hcEBwZXRyb2xpYXNoZXZ5Y2gucmVzdDox 
Accept: */*
Content-Length: 228

Example of Request Body

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

{  
    "active":true,
    "assignToResource":true,
    "addToCapacityCategory":false,
    "translations":[
        {  
            "language":"en",  
            "name":"New work skill group"
        }
    ],
    "workSkills":[  
        {  
            "label":"NP",
            "ratio":100
        }
    ]
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201 Created
Server: nginx/1.6.2
Date: Fri, 24 Jul 2015 08:54:08 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive

Example of Response Body

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

{ 
    "label":"new_ws_group",
    "name":"New work skill group",
    "active":true,
    "assignToResource":true,
    "addToCapacityCategory":false,
    "translations":[
        { 
            "language":"en", 
            "name":"New work skill group"
        }
    ],
    "workSkills":[ 
        { 
            "label":"NP",
            "ratio":100
        }
    ],
    "links":[ 
        { 
            "rel":"canonical",
            "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workSkillGroups/new_ws_group"
        },
        { 
            "rel":"describedby",
            "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workSkillGroups"
        }
    ]
}
Back to Top