Get work skill groups

get

/rest/ofscMetadata/v1/workSkillGroups

This operation retrieves a collection of work skill groups.

The response contains the translations of the work skill group name in the user's language in the translation structure and in the entity fields.

Request

Query Parameters
  • The number of work skill groups to be returned in the response. The minimum value that can be specified is 1. The maximum value that can be specified is 100. If no value or a value greater than 100 is specified, then it defaults to 100.

  • The number of work skill groups to be skipped from the start of the collection in the response. 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

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : WorkSkillGroups
Type: object
The collection of work skill groups.
Show Source
Nested Schema : items
Type: array
Show Source
Nested 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 get work skill groups 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/workSkillGroups/?limit=5&offset=2 HTTP/1.1
Host: <instance_name>.etadirect.com 
Authorization: Basic c29hcEBwZXRyb2xpYXNoZXZ5Y2gucmVzdDox 
Accept: */*

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.3
Date: Wed, 16 Sep 2015 15:32:19 GMT
Content-Type: application/json; charset=utf-8
Connection: close
X-Powered-By: PHP/5.5.28

Example of Response Body

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

{ 
    "totalResults":11,
    "limit":5,
    "offset":2,
    "items":[ 
        { 
            "label":"ws_group_1",
            "name":"Work skill group 1",
            "active":true,
            "assignToResource":true,
            "addToCapacityCategory":true,
            "translations":[
                {
                    "language":"en", 
                    "name":"Work skill group 1"
                },
                {
                    "language":"es",
                    "name":"Work skill group 1"
                }
             ],
            "workSkills":[ 
                { 
                    "label":"NP",
                    "ratio":10
                },
                { 
                    "label":"UP",
                    "ratio":100
                }
            ],
             "links":[ 
                { 
                    "rel":"canonical",
                    "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workSkillGroups/ws_group_1"
                },
                { 
                    "rel":"describedby",
                    "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workSkillGroups"
                }
            ]
        },
        { 
            "label":"ws_group_2",
            "name":"Work skill group 2",
            "active":true,
            "assignToResource":false,
            "addToCapacityCategory":false,
            "translations":[
                { 
                    "language":"en",  
                    "name":"Work skill group 2"
                }
            ],
            "workSkills":[
                { 
                    "label":"UP",
                    "ratio":100
                }
            ],
            "links":[ 
                { 
                    "rel":"canonical",
                    "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workSkillGroups/ws_group_2"
                },
                { 
                    "rel":"describedby",
                    "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workSkillGroups"
                }
            ]
        },
        {...},
        {...},
        {...}
   ],
    "links":[ 
        { 
            "rel":"canonical",
            "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workSkillGroups/?limit=5&offset=2"
        },
        { 
            "rel":"prev",
            "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workSkillGroups/?limit=5&offset=0"
        },
        { 
            "rel":"next",
            "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/workSkillGroups/?limit=5&offset=7"
        },
        { 
            "rel":"describedby",
            "href":"https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workSkillgroups"
        }
    ]
}
Back to Top