Jump to

• Request
• Response

Generate calendar data for a work center resource in the Work Center Resource Calendar task.

post

/fscmRestApi/resources/11.13.18.05/workCenterResourceExceptions/action/generateWorkCenterResourceCalendarData

Generate the calendar data for a specified date range for the specified work center resource. The calendar information shows the active shifts and available units, as well as known shift and resource exceptions which alter standard working time. This action is intended for use in Oracle Fusion Cloud Manufacturing or Maintenance when viewing resource availability.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• endDate: string (date)
  Date where the work center resource calendar data can be rendered in the future without an additional request. This value is required. The value must be in the ISO8601 format such as YYYY-MM-DD.
• organizationId: string
  Value that uniquely identifies the inventory organization that's the plant.
• resourceId: string
  Value that uniquely identifies the resource being updated. This value is required.
• startDate: string (date)
  Date where the work center resource calendar data can be rendered in the past without an additional request. This value is required. The value must be in the ISO8601 format such as YYYY-MM-DD.
• workCenterId: string
  Value that uniquely identifies the work center associated to the resource. This value is required.

{
    "type":"object",
    "properties":{
        "organizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the inventory organization that's the plant.",
            "nullable":true
        },
        "resourceId":{
            "type":"string",
            "description":"Value that uniquely identifies the resource being updated. This value is required.",
            "nullable":true
        },
        "endDate":{
            "type":"string",
            "description":"Date where the work center resource calendar data can be rendered in the future without an additional request. This value is required. The value must be in the ISO8601 format such as YYYY-MM-DD.",
            "format":"date",
            "nullable":true
        },
        "workCenterId":{
            "type":"string",
            "description":"Value that uniquely identifies the work center associated to the resource. This value is required.",
            "nullable":true
        },
        "startDate":{
            "type":"string",
            "description":"Date where the work center resource calendar data can be rendered in the past without an additional request. This value is required. The value must be in the ISO8601 format such as YYYY-MM-DD.",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  A collection of intervals modeling resource working time. Each interval identifies the shift, exception parent, start and end time, and available units value.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "description":"A collection of intervals modeling resource working time. Each interval identifies the shift, exception parent, start and end time, and available units value."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "description":"A collection of intervals modeling resource working time. Each interval identifies the shift, exception parent, start and end time, and available units value."
}

A collection of intervals modeling resource working time. Each interval identifies the shift, exception parent, start and end time, and available units value.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top