Jump to

• Request
• Response

Request changing a single calendar event

post

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/calendars/{calendarsUniqID}/action/applyCalendarPattern

Request changing a single calendar event to run scenarios with changing downtime or availability to assess the impact to the schedule.

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• calendarsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId and CalendarId ---for the Calendars resource and used to uniquely identify an instance of Calendars. The client should not generate the hash key value. Instead, the client should query on the Calendars collection resource with a filter on the primary key values in order to navigate to a specific instance of Calendars.
  
  For example: calendars?q=PlanId=<value1>;CalendarId=<value2>

Header Parameters

• Metadata-Context:
  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:
  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

• endDateTime: string
  Date and time when the calendar event ends.
• eventType: string
  Type of calendar event. Valid values are Delay or Down.
• recurOnDaysOfWeek: array recurOnDaysOfWeek
  Day of the week for which the calendar pattern is applied.
• recurrenceEndDate: string
  Date when the calendar changes end.
• recurrenceStartDate: string
  Date when the calendar changes start.
• startDateTime: string
  Date and time when the calendar event begins.
• timezone: string
  Time zone of the production scheduling organization.

{
    "type":"object",
    "properties":{
        "recurrenceEndDate":{
            "type":"string",
            "description":"Date when the calendar changes end.",
            "nullable":true
        },
        "startDateTime":{
            "type":"string",
            "description":"Date and time when the calendar event begins.",
            "nullable":true
        },
        "recurrenceStartDate":{
            "type":"string",
            "description":"Date when the calendar changes start.",
            "nullable":true
        },
        "recurOnDaysOfWeek":{
            "type":"array",
            "description":"Day of the week for which the calendar pattern is applied.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "timezone":{
            "type":"string",
            "description":"Time zone of the production scheduling organization.",
            "nullable":true
        },
        "eventType":{
            "type":"string",
            "description":"Type of calendar event. Valid values are Delay or Down.",
            "nullable":true
        },
        "endDateTime":{
            "type":"string",
            "description":"Date and time when the calendar event ends.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : recurOnDaysOfWeek

Type: array

Day of the week for which the calendar pattern is applied.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Day of the week for which the calendar pattern is applied.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

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): string
  If the request is successful, then the action returns a value of True and the estimated number of changes.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the request is successful, then the action returns a value of True and the estimated number of changes."
        }
    },
    "additionalProperties":false
}

Back to Top