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 Top

Response

Supported Media Types

200 Response

This section describes the 200 status response for this operation.
Body ()
Root Schema : WorkSkillConditions
Type: object
The collection of work skill conditions.
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : Work Skill Condition
Type: object
Title: Work Skill Condition
Show Source
  • Conditions
    Title: Conditions
    The array of condition objects.
  • Dependencies
    Title: Dependencies
    The array of dependency objects.
  • 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 OFSC does not necessarily match the obtained values in the GET operation.
  • Title: Label
    Minimum Length: 1
    Maximum Length: 40
    The label of the work skill condition. This field is required for all conditions. The label cannot be changed for an existing condition.
  • Title: Preferable Level
    Minimum Value: 1
    Maximum Value: 100
    The preference level of a work skill condition. This field is required for all conditions.
  • Title: Required Level
    Minimum Value: 0
    Maximum Value: 100
    The work skill level required for a condition. 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: object
Show Source
  • Allowed Values: [ "in", "notIn", "contains", "dContain", "isNull", "isNotNull", ">", "<", ">=", "<=", "startsWith", "dStartWith" ]
    The function used by the condition to test a property.
  • Minimum Length: 1
    Maximum Length: 40
    The label of the condition object.
  • 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
    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.

A list of strings can be used to test string fields. A list of enumeration labels can be used to test enumeration fields.

Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : dependency
Type: array
The array of objects containing the internal ID fields.
Show Source
Nested Schema : items
Type: object
Show Source
  • Minimum Value: 1
    Minimum Length: 1
    Maximum Length: 10
    The internal ID of the dependency object.

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 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>.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": 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>.etadirect.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>.etadirect.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>.etadirect.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>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog/workSkillConditions"
        }
      ]
    }
  ]
}
Back to Top