Jump to

• Request
• Response
• Examples

Create or update a shift

put

/rest/ofscMetadata/v1/shifts/{label}

This operation creates a new shift or updates an existing shift.

• If shift with 'label' already exists, the function replaces it with the new values.
• Response code 200 is returned when an shift object is updated.
• Response code 201 is returned when an shift object is created.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 32

  The label of the shift that is used in the request URL to create a new shift or update an existing shift.

Body ()

The shift object created or updated in Oracle Field Service.

Root Schema : shift

Type: object

Title: shift

The shift object.

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true.

• decoration: string
  Title: Type

  The decoration of the shift. Mandatory for "on-call" type of shift. Possible values are ["yellow","orange","red","blue","green","purple"].
• name(required): string
  Title: Name

  The label of the shift.
• points: integer
  Title: Points

  Points
• type(required): string
  Title: Type

  The type of the shift. Possible values are ["regular", "on-call"]. Cannot be changed for an existing shift.
• workTimeEnd(required): string
  Title: WorkTimeStart

  The workTimeEnd of the shift. Possible values are 00:00 - 23:59
• workTimeStart(required): string
  Title: WorkTimeStart

  The workTimeStart of the shift. Possible values are 00:00 - 23:59

{
    "type":"object",
    "title":"shift",
    "description":"The shift object.",
    "properties":{
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The label of the shift."
        },
        "points":{
            "type":"integer",
            "title":"Points",
            "description":"Points"
        },
        "type":{
            "type":"string",
            "title":"Type",
            "description":"The type of the shift. Possible values are [\"regular\", \"on-call\"]. Cannot be changed for an existing shift."
        },
        "workTimeStart":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeStart of the shift. Possible values are 00:00 - 23:59"
        },
        "workTimeEnd":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeEnd of the shift. Possible values are 00:00 - 23:59"
        },
        "decoration":{
            "type":"string",
            "title":"Type",
            "description":"The decoration of the shift. Mandatory for \"on-call\" type of shift. Possible values are [\"yellow\",\"orange\",\"red\",\"blue\",\"green\",\"purple\"]. "
        }
    },
    "required":[
        "name",
        "active",
        "type",
        "workTimeEnd",
        "workTimeStart"
    ]
}

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation. The 200 status code is returned when an shift object is updated.

Body ()

Root Schema : Shift

Type: object

Title: Shift

The shift object.

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true.

• decoration: string
  Title: Type

  The decoration of the shift. Mandatory for "on-call" type of shift. Possible values are ["yellow","orange","red","blue","green","purple"].
• name(required): string
  Title: Name

  The label of the shift.
• points: integer
  Title: Points

  Points
• type(required): string
  Title: Type

  The type of the shift. Possible values are ["regular", "on-call"]. Cannot be changed for an existing shift.
• workTimeEnd(required): string
  Title: WorkTimeStart

  The workTimeEnd of the shift. Possible values are 00:00 - 23:59
• workTimeStart(required): string
  Title: WorkTimeStart

  The workTimeStart of the shift. Possible values are 00:00 - 23:59

{
    "type":"object",
    "title":"Shift",
    "description":"The shift object.",
    "properties":{
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The label of the shift."
        },
        "points":{
            "type":"integer",
            "title":"Points",
            "description":"Points"
        },
        "type":{
            "type":"string",
            "title":"Type",
            "description":"The type of the shift. Possible values are [\"regular\", \"on-call\"]. Cannot be changed for an existing shift."
        },
        "workTimeStart":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeStart of the shift. Possible values are 00:00 - 23:59"
        },
        "workTimeEnd":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeEnd of the shift. Possible values are 00:00 - 23:59"
        },
        "decoration":{
            "type":"string",
            "title":"Type",
            "description":"The decoration of the shift. Mandatory for \"on-call\" type of shift. Possible values are [\"yellow\",\"orange\",\"red\",\"blue\",\"green\",\"purple\"]. "
        }
    },
    "required":[
        "name",
        "active",
        "type",
        "workTimeEnd",
        "workTimeStart"
    ]
}

201 Response

This section describes the 201 status response for this operation. This response code indicates that the shift object is created. The shift object is returned in the response.

Body ()

Root Schema : Shift

Type: object

Title: Shift

The shift object.

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true.

• decoration: string
  Title: Type

  The decoration of the shift. Mandatory for "on-call" type of shift. Possible values are ["yellow","orange","red","blue","green","purple"].
• name(required): string
  Title: Name

  The label of the shift.
• points: integer
  Title: Points

  Points
• type(required): string
  Title: Type

  The type of the shift. Possible values are ["regular", "on-call"]. Cannot be changed for an existing shift.
• workTimeEnd(required): string
  Title: WorkTimeStart

  The workTimeEnd of the shift. Possible values are 00:00 - 23:59
• workTimeStart(required): string
  Title: WorkTimeStart

  The workTimeStart of the shift. Possible values are 00:00 - 23:59

{
    "type":"object",
    "title":"Shift",
    "description":"The shift object.",
    "properties":{
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the shift is listed as a possible value in the 'shift' drop-down list in Manage or Mobility apps while creating an activity. If false, then the shift is not listed as a value in the drop-down list. The default value is true."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The label of the shift."
        },
        "points":{
            "type":"integer",
            "title":"Points",
            "description":"Points"
        },
        "type":{
            "type":"string",
            "title":"Type",
            "description":"The type of the shift. Possible values are [\"regular\", \"on-call\"]. Cannot be changed for an existing shift."
        },
        "workTimeStart":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeStart of the shift. Possible values are 00:00 - 23:59"
        },
        "workTimeEnd":{
            "type":"string",
            "title":"WorkTimeStart",
            "description":"The workTimeEnd of the shift. Possible values are 00:00 - 23:59"
        },
        "decoration":{
            "type":"string",
            "title":"Type",
            "description":"The decoration of the shift. Mandatory for \"on-call\" type of shift. Possible values are [\"yellow\",\"orange\",\"red\",\"blue\",\"green\",\"purple\"]. "
        }
    },
    "required":[
        "name",
        "active",
        "type",
        "workTimeEnd",
        "workTimeStart"
    ]
}

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 create or update a shift by by submitting a PUT request on the REST resource using cURL.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -X PUT --data @request.json 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/shifts/{label}

Example of Request Body

The following shows an example of the request body in json format.

{
        "name": "Regular Shift",
        "active": true,
        "type":"regular"
        "points": 13,
        "workTimeStart": "00:00",
        "workTimeEnd": "18:00"
}

Example of Response Body

The following shows an example of the response body in json format.

{
        "name": "Regular Shift",
        "active": true,
        "type":"regular",
        "points": 13,
        "workTimeStart": "00:00",
        "workTimeEnd": "18:00"
        "label": "type_on_regular_shift"
}

Back to Top