REST API for Oracle Field Service Cloud Service

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

limit: integer

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.
offset: integer

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.

Response

Supported Media Types

application/json
application/schema+json

200 Response

This section describes the 200 status response for this operation.

Root Schema : WorkSkillGroups

Type: object

The collection of work skill groups.

Show Source

items: array items
limit: integer

The limit value specified in the request.
offset: integer

The offset value specified in the request.
totalResults: integer

The total number of work skill groups in the collection.

{
    "description":"The collection of work skill groups.",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkSkillGroup"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of work skill groups in the collection."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request."
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Work Skill Group

Title: Work Skill Group

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkSkillGroup"
    }
}

Nested Schema : Work Skill Group

Type: object

Title: Work Skill Group

Show Source

active(required): boolean

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.
addToCapacityCategory(required): boolean

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.
assignToResource(required): boolean

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.
label: string

Title: Label

Minimum Length: 1

Maximum Length: 40

The label of the work skill group.
name: string

Title: Name

Minimum Length: 1

Maximum Length: 5000

The name of the work skill group in the user's language.
translations(required): array Translations

Title: Translations

The array of translation objects associated with the work skill group.
workSkills: array Work Skills

Title: Work Skills

The array of work skill objects associated with the work skill group.

{
    "type":"object",
    "title":"Work Skill Group",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Label",
            "description":"The label of the work skill group."
        },
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"5000",
            "title":"Name",
            "description":"The name of the work skill group in the user's language. "
        },
        "assignToResource":{
            "type":"boolean",
            "title":"Assign to Resource",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is assigned to the resource. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "addToCapacityCategory":{
            "type":"boolean",
            "title":"Add to Capacity Category",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is added to the capacity category. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true. </p><p><b>Note: </b>It is present for all work skill groups.</p>"
        },
        "workSkills":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the work skill object.",
                        "type":"string"
                    },
                    "ratio":{
                        "description":"The ratio used to assign the work skill group to a resource.",
                        "type":"integer",
                        "maximum":"100",
                        "minimum":"1"
                    }
                },
                "required":[
                    "label",
                    "ratio"
                ]
            },
            "title":"Work Skills",
            "description":"The array of work skill objects associated with the work skill group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the work skill group."
        }
    },
    "required":[
        "assignToResource",
        "addToCapacityCategory",
        "active",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the work skill group.

Show Source

Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the work skill group."
}

Nested Schema : Work Skills

Type: array

Title: Work Skills

The array of work skill objects associated with the work skill group.

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the work skill object.",
                "type":"string"
            },
            "ratio":{
                "description":"The ratio used to assign the work skill group to a resource.",
                "type":"integer",
                "maximum":"100",
                "minimum":"1"
            }
        },
        "required":[
            "label",
            "ratio"
        ]
    },
    "title":"Work Skills",
    "description":"The array of work skill objects associated with the work skill group."
}

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 object.
ratio(required): integer

Minimum Value: 1

Maximum Value: 100

The ratio used to assign the work skill group to a resource.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the work skill object.",
            "type":"string"
        },
        "ratio":{
            "description":"The ratio used to assign the work skill group to a resource.",
            "type":"integer",
            "maximum":"100",
            "minimum":"1"
        }
    },
    "required":[
        "label",
        "ratio"
    ]
}

Default Response

This section describes the default error response for this operation.

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"
    ]
}

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>.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/ws_group_1"
                },
                { 
                    "rel":"describedby",
                    "href":"https://<instance_name>.fs.ocs.oraclecloud.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>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/ws_group_2"
                },
                { 
                    "rel":"describedby",
                    "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillGroups"
                }
            ]
        },
        {...},
        {...},
        {...}
   ],
    "links":[ 
        { 
            "rel":"canonical",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/?limit=5&offset=2"
        },
        { 
            "rel":"prev",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/?limit=5&offset=0"
        },
        { 
            "rel":"next",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/?limit=5&offset=7"
        },
        { 
            "rel":"describedby",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillgroups"
        }
    ]
}