Get work skill conditions
get
/rest/ofscMetadata/v1/workSkillConditions
This operation retrieves a list of work skill conditions.
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
- application/schema+json
200 Response
This section describes the 200 status response for this operation.
Root Schema : WorkSkillConditions
Type:
object
The collection of work skill conditions.
Show Source
-
items:
array items
-
totalResults:
integer
The total number of work skill conditions returned.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Work Skill Condition
Title:
Work Skill Condition
Nested Schema : Work Skill Condition
Type:
object
Title:
Show Source
Work Skill Condition
-
conditions:
array Conditions
Title:
Conditions
The array of condition objects. -
dependencies:
array Dependencies
Title:
Dependencies
The array of dependency objects. -
internalId(required):
integer
Title:
Internal ID
Minimum Value:1
Minimum Length:1
Maximum Length:10
The unique identifier of a work skill condition item within the request. This value may be used for reference in the 'dependencies' array of another condition. The values of Id sent to Oracle Field Service does not necessarily match the obtained values in the GET operation. -
label(required):
string
Title:
Label
Minimum Length:1
Maximum Length:40
The label of a work skill. This field is required for all conditions. -
preferableLevel(required):
integer
Title:
Preferable Level
Minimum Value:1
Maximum Value:100
The preference level of the work skill. This field is required for all conditions. -
requiredLevel(required):
integer
Title:
Required Level
Minimum Value:0
Maximum Value:100
The required level of the work skill. This field is required for all conditions.
Nested Schema : Conditions
Type:
array
Title:
Conditions
The array of condition objects.
Show Source
Nested Schema : Dependencies
Type:
array
Title:
Dependencies
The array of dependency objects.
Show Source
Nested Schema : items
Type:
Show Source
object
-
function(required):
string
Allowed Values:
[ "in", "notIn", "contains", "dContain", "isNull", "isNotNull", ">", "<", ">=", "<=", "startsWith", "dStartWith" ]
The function used by the condition to test a property. -
label(required):
string
Minimum Length:
1
Maximum Length:40
The label of the condition object. -
value:
string
The value used by the condition to test a function. This value is ignored for 'isNull' and 'isNotNull' functions, as they do not require parameters. It is also ignored for 'in' and 'notIn' functions, as they require list of parameters.
-
valueList:
array valueList
The array of values used by the condition to test a function. This field is used for testing 'in' and 'notIn' functions.
A list of strings can be used to test string fields. A list of enumeration labels can be used to test enumeration fields.
Nested Schema : valueList
Type:
array
The array of values used by the condition to test a function. This field is used for testing 'in' and 'notIn' functions.
Show Source
A list of strings can be used to test string fields. A list of enumeration labels can be used to test enumeration fields.
Nested Schema : items
Type:
Show Source
object
-
dependency(required):
array dependency
The array of objects containing the internal ID fields.
-
type(required):
string
Allowed Values:
[ "selected", "notSelected" ]
The type of the dependency.
Nested Schema : dependency
Type:
array
The array of objects containing the internal ID fields.
Show Source
Nested Schema : items
Type:
Show Source
object
-
internalId(required):
integer
Minimum Value:
1
Minimum Length:1
Maximum Length:10
The internal ID of the work skill condition item within the request.
Default Response
This section describes the default error response for this operation.
Root Schema : Error
Type:
Show Source
object
-
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.
Examples
The following example shows how to get work skill conditions 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/workSkillConditions 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": 4, "items": [ { "internalId": 151, "label": "test", "requiredLevel": 1, "preferableLevel": 2, "conditions": [ { "label": "WO_TYPE", "function": "in", "value": "3" } ], "dependencies": [], "links": [ { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillConditions" } ] }, { "internalId": 152, "label": "test2", "requiredLevel": 1, "preferableLevel": 22, "conditions": [ { "label": "WO_TYPE", "function": "in", "value": "3,4" } ], "dependencies": [], "links": [ { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillConditions" } ] }, { "internalId": 153, "label": "test", "requiredLevel": 1, "preferableLevel": 22, "conditions": [], "dependencies": [ { "type": "not_selected", "dependency": [ { "internalId": 151 } ] } ], "links": [ { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillConditions" } ] }, { "internalId": 154, "label": "test2", "requiredLevel": 1, "preferableLevel": 3, "conditions": [], "dependencies": [ { "type": "selected", "dependency": [ { "internalId": 151 }, { "internalId": 153 } ] } ], "links": [ { "rel": "describedby", "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillConditions" } ] } ] }