Jump to

• Request
• Response
• Examples

Get work skills

get

/rest/ofscCore/v1/resources/{resourceId}/workSkills

This operation retrieves the details about the work skills assigned to the specified resource.

Request

Path Parameters

• resourceId(required): string
  The unique identifier of the resource in Oracle Field Service.

Query Parameters

• dateFrom: string(date)
  The work skills, which are active starting from the specified date, are retrieved in the response. Specify the date in YYYY-MM-DD format.
• dateTo: string(date)
  The work skills, which are active starting from the date in the dateFrom parameter till the specified date, are retrieved in the response. Specify the date in YYYY-MM-DD format. If you specify the dateTo parameter, then you must also specify the dateFrom parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Work Skills

Type: object

Title: Work Skills

The collection of resource work skill items.

Show Source

• items: array Items
  Title: Items

  An array of objects containing the details of the work skills of the resource.
• links(required): array links
• totalResults(required): integer
  Title: Total Results

  The total number of resources work skills returned.

{
    "properties":{
        "items":{
            "items":{
                "$ref":"#/definitions/resourceWorkSkill"
            },
            "type":"array",
            "description":"An array of objects containing the details of the work skills of the resource.",
            "title":"Items"
        },
        "totalResults":{
            "type":"integer",
            "description":"The total number of resources work skills returned.",
            "title":"Total Results"
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                },
                "required":[
                    "rel",
                    "href"
                ]
            }
        }
    },
    "type":"object",
    "description":"The collection of resource work skill items.",
    "title":"Work Skills",
    "required":[
        "totalResults",
        "links"
    ]
}

Nested Schema : Items

Type: array

Title: Items

An array of objects containing the details of the work skills of the resource.

Show Source

• Array of: object Work Skill
  Title: Work Skill

{
    "items":{
        "$ref":"#/definitions/resourceWorkSkill"
    },
    "type":"array",
    "description":"An array of objects containing the details of the work skills of the resource.",
    "title":"Items"
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : Work Skill

Type: object

Title: Work Skill

Show Source

• endDate: string
  Title: End Date

  The date until when the work skill is effective. Specify the date in 'YYYY-MM-DD' format.
• ratio(required): integer
  Title: Ratio

  Minimum Value: 0

  Maximum Value: 100

  The skill level of the resource.
• startDate: string
  Title: Start Date

  The date when the work skill takes effect. Specify the date in 'YYYY-MM-DD' format.
• workSkill(required): string
  Title: Work Skill Label

  Maximum Length: 40

  The label of the work skill.

{
    "title":"Work Skill",
    "type":"object",
    "required":[
        "workSkill",
        "ratio"
    ],
    "properties":{
        "workSkill":{
            "type":"string",
            "title":"Work Skill Label",
            "maxLength":"40",
            "description":"The label of the work skill."
        },
        "ratio":{
            "type":"integer",
            "minimum":"0",
            "maximum":"100",
            "title":"Ratio",
            "description":"The skill level of the resource."
        },
        "startDate":{
            "type":"string",
            "title":"Start Date",
            "description":"The date when the work skill takes effect. Specify the date in 'YYYY-MM-DD' format."
        },
        "endDate":{
            "type":"string",
            "title":"End Date",
            "description":"The date until when the work skill is effective. Specify the date in 'YYYY-MM-DD' format."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

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

Back to Top

Examples

The following example shows how to get work skills for a resource by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /rest/ofscCore/v1/resources/33011/workSkills HTTP/1.0

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK

Example of Response Body

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

{
	"items": [
		{
			"workSkill": "NP",
			"ratio": 50,
			"startDate": "2016-07-06"
		},
		{
			"workSkill": "Routing",
			"ratio": 100,
			"startDate": "2016-07-08",
			"endDate": "2016-07-09"
		}
	],
	"totalResults": 2,
	"links": [
		{
			"rel": "canonical",
			"href": "http://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/john.smith/workSkills"
		}
	]
}

Back to Top