Jump to

• Request
• Response

Update a resource availability override

patch

/fscmRestApi/resources/11.13.18.05/productionCalendarShiftExceptions/{PlantShiftExceptionId}/child/resourceAvailabilityOverrides/{resourceAvailabilityOverridesUniqID}

Request

Path Parameters

• PlantShiftExceptionId(required): integer(int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• resourceAvailabilityOverridesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Resource Availability Overrides resource and used to uniquely identify an instance of Resource Availability Overrides. The client should not generate the hash key value. Instead, the client should query on the Resource Availability Overrides collection resource in order to navigate to a specific instance of Resource Availability Overrides to get the hash key.

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AvailabilityOverride: number
  Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required.
• DefaultAvailability: integer (int64)
  Value of the resource availability.
• ExceptionDuration: integer (int64)
  Duration in Hours for the work center resource exception. This value is required.
• ExceptionEndTimeInMs: integer (int64)
  Title: End Time

  Time in microseconds from midnight when the work center resource exception ends.
• ExceptionStartTime: string
  Maximum Length: 255

  Time when the work center resource exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
• ExceptionStartTimeInMs: integer (int64)
  Title: Start Time

  Time in microseconds from midnight when the work center resource exception starts.
• PlantShiftExceptionId: integer (int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource being updated. This value is required.
• ResourceName: string
  Maximum Length: 255

  Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.
• WorkCenterCode: string
  Maximum Length: 255

  User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center associated with the resource. This value is required.
• WorkCenterName: string
  Maximum Length: 255

  Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.
• WorkCenterResourceExceptionDetailId: integer (int64)
  Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.
• WorkCenterResourceExceptionId: integer (int64)
  Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.

{
    "type":"object",
    "properties":{
        "WorkCenterName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.",
            "nullable":true
        },
        "ExceptionDuration":{
            "type":"integer",
            "description":"Duration in Hours for the work center resource exception. This value is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center associated with the resource. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.",
            "nullable":true
        },
        "WorkCenterResourceExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DefaultAvailability":{
            "type":"integer",
            "description":"Value of the resource availability.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            }
        },
        "ExceptionStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the work center resource exception starts. This value is required. It must be formatted as \"HH:MM AM|PM\".",
            "nullable":true
        },
        "AvailabilityOverride":{
            "type":"number",
            "description":"Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required. ",
            "nullable":false
        },
        "ExceptionEndTimeInMs":{
            "title":"End Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception ends.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource being updated. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkCenterResourceExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlantShiftExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExceptionStartTimeInMs":{
            "title":"Start Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception starts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkCenterCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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.

Body ()

Root Schema : productionCalendarShiftExceptions-resourceAvailabilityOverrides-item-response

Type: object

Show Source

• AvailabilityOverride: number
  Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• DefaultAvailability: integer (int64)
  Value of the resource availability.
• ExceptionDuration: integer (int64)
  Duration in Hours for the work center resource exception. This value is required.
• ExceptionEndTime: string
  Read Only: true

  Maximum Length: 255

  Time when the work center resource exception ends. It's derived from the start time and duration and isn't input.
• ExceptionEndTimeInMs: integer (int64)
  Title: End Time

  Time in microseconds from midnight when the work center resource exception ends.
• ExceptionStartTime: string
  Maximum Length: 255

  Time when the work center resource exception starts. This value is required. It must be formatted as "HH:MM AM|PM".
• ExceptionStartTimeInMs: integer (int64)
  Title: Start Time

  Time in microseconds from midnight when the work center resource exception starts.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlantShiftExceptionId: integer (int64)
  Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource being updated. This value is required.
• ResourceName: string
  Maximum Length: 255

  Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.
• WorkCenterCode: string
  Maximum Length: 255

  User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center associated with the resource. This value is required.
• WorkCenterName: string
  Maximum Length: 255

  Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.
• WorkCenterResourceExceptionDetailId: integer (int64)
  Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.
• WorkCenterResourceExceptionId: integer (int64)
  Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the work center. It's used if the WorkCenterCode isn't provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionDuration":{
            "type":"integer",
            "description":"Duration in Hours for the work center resource exception. This value is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center associated with the resource. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the resource. It's used if the ResourceId isn't provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionEndTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the work center resource exception ends. It's derived from the start time and duration and isn't input.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterResourceExceptionDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource availability override. The application generates this value when it creates the exception for the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DefaultAvailability":{
            "type":"integer",
            "description":"Value of the resource availability.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ExceptionStartTime":{
            "maxLength":255,
            "type":"string",
            "description":"Time when the work center resource exception starts. This value is required. It must be formatted as \"HH:MM AM|PM\".",
            "nullable":true,
            "x-queryable":true
        },
        "AvailabilityOverride":{
            "type":"number",
            "description":"Value of the override quantity. This replaces the default units available for a given resource for the time interval defined by the exception. This value is required. ",
            "nullable":false,
            "x-queryable":true
        },
        "ExceptionEndTimeInMs":{
            "title":"End Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception ends.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource being updated. This value is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterResourceExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center resource exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlantShiftExceptionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift exception in the production calendar of a plant. The application generates this value when it creates the exception.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExceptionStartTimeInMs":{
            "title":"Start Time",
            "type":"integer",
            "description":"Time in microseconds from midnight when the work center resource exception starts.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":255,
            "type":"string",
            "description":"User-supplied value that uniquely identifies the work center associated with the resource. It's used if the WorkCenterId isn't provided in the request.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top