REST API for Oracle Field Service Cloud Service

Get work skills

get

/rest/ofscMetadata/v1/workSkills

This operation retrieves a collection of work skills.

Request

Query Parameters

limit: integer

The number of work skills to be returned in the response. The minimum value that can be specified is 1 and the maximum value that can be specified is 100. If the specified value is greater than 100, zero, or if no value is specified, then it defaults to 100.
offset: integer

The number of work skills to be skipped in the response. The default value is zero. 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 : WorkSkills

Type: object

The collection of work skills.

Show Source

hasMore: boolean

Contains one of the following values: true or false.
If true, then there are more results that can be retrieved with successive paging requests.
If false or if the value is not present, then there are no more results or this is the final page. The default value is true.
items: array items

The collection of work skills. It is not returned for an empty collection.
limit: integer

The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100.
offset: integer

The offset value specified in the request.
totalResults: integer

The total number of the non-working reason records in the collection.

{
    "description":"The collection of work skills.",
    "properties":{
        "items":{
            "type":"array",
            "description":"The collection of work skills. It is not returned for an empty collection.",
            "items":{
                "$ref":"#/definitions/WorkSkill"
            }
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of the non-working reason records in the collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false.<p>If true, then there are more results that can be retrieved with successive paging requests.</p><p>If false or if the value is not present, then there are no more results or this is the final page. The default value is true.</p>"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value specified in the request."
        },
        "limit":{
            "type":"integer",
            "description":"The limit value specified in the request. If the value is not specified in the request or if the specified value is not accepted, then it defaults to 100."
        }
    }
}

Nested Schema : items

Type: array

The collection of work skills. It is not returned for an empty collection.

Show Source

Array of: object Work Skills

Title: Work Skills

{
    "type":"array",
    "description":"The collection of work skills. It is not returned for an empty collection.",
    "items":{
        "$ref":"#/definitions/WorkSkill"
    }
}

Nested Schema : Work Skills

Type: object

Title: Work Skills

Show Source

active(required): boolean

Title: Active

Contains one of the following values: true or false.
If true, then the work skill is active. If false, then the work skill is inactive. By default, it is true.
label: string

Title: Label

Minimum Length: 1

Maximum Length: 40

The label of the work skill specified in the request.
name: string

Title: Name

The name of the work skill in user's language.
sharing(required): string
Title: Sharing

Allowed Values: [ "no sharing", "maximal", "minimal", "summary" ]
The sharing option defined for work skills in the team.
The allowed values are as follows:
- Maximal: The team gets the maximum work skill level of all team members. This is the default value.
- Minimal: The team gets the minimal work skill level of all team members.
- No sharing: The team does not get the work skill of a team member.
- Summary: The team gets the total sum of work skill levels of all the team members.
translations: array Translations

Title: Translations

The list of translations associated with the name of the work skill.

{
    "type":"object",
    "title":"Work Skills",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Label",
            "description":"The label of the work skill specified in the request."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The name of the work skill in user's language."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the work skill is active. If false, then the work skill is inactive. By default, it is true."
        },
        "sharing":{
            "type":"string",
            "enum":[
                "no sharing",
                "maximal",
                "minimal",
                "summary"
            ],
            "title":"Sharing",
            "description":"The sharing option defined for work skills in the team. <p>The allowed values are as follows:</p><ul><li>Maximal: The team gets the maximum work skill level of all team members. This is the default value.</li><li>Minimal: The team gets the minimal work skill level of all team members.</li><li>No sharing: The team does not get the work skill of a team member.</li><li>Summary: The team gets the total sum of work skill levels of all the team members.</li></ul>"
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The list of translations associated with the name of the work skill."
        }
    },
    "required":[
        "active",
        "sharing"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of translations associated with the name of the work skill.

Show Source

Array of: object Translation

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

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

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 a collection of work skills by submitting a GET request on the REST resource using cURL.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscMetadata/v1/workSkills/?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
Date: Thu, 03 Mar 2016 16:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Example of Response Body

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

{
    "hasMore": true,
    "totalResults": 19,
    "limit": 2,
    "offset": 2,
    "items": [
        {
            "label": "UP",
            "name": "Upgrade",
            "active": true,
            "sharing": "maximal",
            "translations": [
                {
                    "language":"en",
                    "name": "Upgrade"
                },
                {
                    "language":"es",
                    "name": "Upgrade"
                },
                {
                    "language":"ru",
                    "name": "\u041e\u0431\u043d\u043e\u0432\u043b\u0435\u043d\u0438\u0435"
                }
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills/UP"
                },
                {
                    "rel": "workSkillConditions",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills/UP/workSkillConditions"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/metadata-catalog/workSkills"
                }
            ]
        },
        {
            "label": "DI",
            "active": true,
            "sharing": "maximal",
            "translations": [
                {
                    "language":"en",
                    "name": "Deinstall"
                },
                {
                        "language":"es",
                    "name": "Deinstall"
                },
                {
                    "language":"ru",
                    "name": "\u0414\u0435\u043c\u043e\u043d\u0442\u0430\u0436"
                }
            ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills/DI"
                },
                {
                    "rel": "workSkillConditions",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills/DI/workSkillConditions"
                },
                {
                    "rel": "describedby",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/metadata-catalog/workSkills"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills?limit=2&offset=2"
        },
        {
            "rel": "prev",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills/?limit=2&offset=0"
        },
        {
            "rel": "next",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/workSkills/?limit=2&offset=4"
        },
        {
            "rel": "describedby",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadataV2/v1/metadata-catalog/workSkills"
        }
    ]
}