Jump to

• Request
• Response
• Examples

Set work skills

post

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

This operation updates the work skills for the specified resource. The operation does the following:

1. Removes all the current work skills (by changing the end date of the work skill to a past date) for the specified resource.
2. Updates the work skills according to the parameters specified in the request.
3. Returns the updated work skills and the deleted work skills.

Request

Path Parameters

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

Body ()

Root Schema : Work Skills

Type: array

Title: Work Skills

An array of objects containing 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 work skills of the resource.",
    "title":"Work Skills"
}

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

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 set work skills for a resource by submitting a POST request on the REST resource.

cURL command Example

curl -X 'POST'  -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -H 'Content-Type: application/json' --data-binary '[
    {
        "workSkill": "NP",
        "ratio": 0,
        "startDate": "2016-07-29"
    },
    {
        "workSkill": "Routing",
        "ratio": 100,
        "startDate": "2016-07-29",
        "endDate": "2016-07-29"
    }
]' 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/testResourceWorkSkilODCGTTRLFJ/workSkills'

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Thu, 28 Jul 2016 11:29:02 GMT
Content-Type: application/json; charset=utf-8
Connection: close
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET, POST, OPTIONS, PUT, DELETE, PATCH
Access-Control-Allow-Headers: DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization

Example of Response Body

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

 
{
    "items": [
        {
            "workSkill": "NP",
            "ratio": 0,
            "startDate": "2016-07-29"
        },
        {
            "workSkill": "Routing",
            "ratio": 100,
            "startDate": "2016-07-29",
            "endDate": "2016-07-29"
        }
    ],
    "totalResults": 2,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/testResourceWorkSkilODCGTTRLFJ/workSkills"
        }
    ]
}

Back to Top