Jump to

• Request
• Response
• Examples

Set a resource work zone

post

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

This operation assigns a work zone to the specified resource.

Request

Path Parameters

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

Body ()

Root Schema : Work Zone

Type: object

Title: Work Zone

Show Source

• endDate: string
  Title: End Date

  The date until when the work zone assignment is effective. Specify the date in 'YYYY-MM-DD' format.
• ratio: integer
  Title: Ratio

  Minimum Value: 1

  Maximum Value: 100

  The work zone ratio of the resource. The default value is 100.
• recurEvery: integer
  Title: Recur Every

  Minimum Value: 1

  Maximum Value: 10000

  The time between each recurrence of the work zone assignment. Depending on the value selected for 'recurrence', the value of the parameter indicates the time between recurrence in days or weeks. For example, if '4' is the value of this parameter, and the 'recurrence' is 'daily', it indicates that the time between each recurrence is four days.
• recurrence: string
  Title: Recurrence

  Allowed Values: [ "weekly", "daily" ]

  The value of this parameter along with the 'Recur Every' parameter defines the time between each recurrence of the work zone assignment. For example, if you specify 'daily' as the value of this parameter and '4' as the value of the 'recurEvery' parameter, then the time between each recurrence is four days.
• startDate(required): string
  Title: Start Date

  The date when the work zone assignment takes effect. Specify the date in 'YYYY-MM-DD' format.
• type: string
  Title: Type

  Allowed Values: [ "regular", "override" ]

  The type of the work zone assignment.
• weekdays: array Weekdays
  Title: Weekdays

  Unique Items Required: true

  The weekdays on which the work zone is assigned to the resources. This parameter is mandatory when the recurrence is weekly.
• workZone(required): string
  Title: Work Zone Label

  Maximum Length: 255

  The identifier of the work zone.
• workZoneItemId: integer
  Title: Work Zone Item ID

  The identifier of the work zone assignment.

{
    "title":"Work Zone",
    "type":"object",
    "properties":{
        "workZone":{
            "type":"string",
            "title":"Work Zone Label",
            "maxLength":255,
            "description":"The identifier of the work zone."
        },
        "ratio":{
            "type":"integer",
            "minimum":1,
            "maximum":100,
            "title":"Ratio",
            "description":"The work zone ratio of the resource. The default value is 100."
        },
        "recurrence":{
            "type":"string",
            "title":"Recurrence",
            "description":"The value of this parameter along with the 'Recur Every' parameter defines the time between each recurrence of the work zone assignment. For example, if you specify 'daily' as the value of this parameter and '4' as the value of the 'recurEvery' parameter, then the time between each recurrence is four days.",
            "enum":[
                "weekly",
                "daily"
            ]
        },
        "type":{
            "type":"string",
            "title":"Type",
            "description":"The type of the work zone assignment.",
            "enum":[
                "regular",
                "override"
            ]
        },
        "weekdays":{
            "title":"Weekdays",
            "description":"The weekdays on which the work zone is assigned to the resources. This parameter is mandatory when the recurrence is weekly.",
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "Sun",
                    "Mon",
                    "Tue",
                    "Wed",
                    "Thu",
                    "Fri",
                    "Sat"
                ]
            },
            "uniqueItems":true
        },
        "recurEvery":{
            "type":"integer",
            "minimum":1,
            "maximum":10000,
            "title":"Recur Every",
            "description":"The time between each recurrence of the work zone assignment. Depending on the value selected for 'recurrence', the  value of the parameter indicates the time between recurrence in days or weeks. For example, if '4' is the value of this parameter, and the 'recurrence' is 'daily', it indicates that the time between each recurrence is four days."
        },
        "startDate":{
            "type":"string",
            "title":"Start Date",
            "description":"The date when the work zone assignment takes effect. Specify the date in 'YYYY-MM-DD' format."
        },
        "endDate":{
            "type":"string",
            "title":"End Date",
            "description":"The date until when the work zone assignment is effective. Specify the date in 'YYYY-MM-DD' format."
        },
        "workZoneItemId":{
            "type":"integer",
            "title":"Work Zone Item ID",
            "description":"The identifier of the work zone assignment."
        }
    },
    "required":[
        "startDate",
        "workZone"
    ]
}

Nested Schema : Weekdays

Type: array

Title: Weekdays

Unique Items Required: true

The weekdays on which the work zone is assigned to the resources. This parameter is mandatory when the recurrence is weekly.

Show Source

• Array of: string
  Allowed Values: [ "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" ]

{
    "title":"Weekdays",
    "description":"The weekdays on which the work zone is assigned to the resources. This parameter is mandatory when the recurrence is weekly.",
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "Sun",
            "Mon",
            "Tue",
            "Wed",
            "Thu",
            "Fri",
            "Sat"
        ]
    },
    "uniqueItems":true
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

This section describes the 204 status response for this operation.

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

Example of Request Header

The following shows an example of the request header.

POST /rest/ofscCore/v1/resources/resource_work_zones/workZones HTTP/1.0

Example of Request Body

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

{
        "workZone": "GENEVA",
        "startDate": "2015-09-16",
        "endDate": "2015-09-18",
        "ratio": 100,
        "weekdays": [
            "Tue",
            "Sat"
        ],
        "recurEvery": 1,
        "recurrence": "weekly"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 204 No Content

Back to Top