Jump to

• Request
• Response
• Examples

Update one resource shift

patch

/fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/productionCalendars/{ProductionCalendarId}/child/resourceShifts/{resourceShiftsUniqID}

Request

Path Parameters

• ProductionCalendarId(required): integer(int64)
  Unique identifier of the work center production calendar's record. Its value is an application-generated unique ID.
• WorkCenterId(required): integer(int64)
  Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center.
• resourceShiftsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Resource Shifts resource and used to uniquely identify an instance of Resource Shifts. The client should not generate the hash key value. Instead, the client should query on the Resource Shifts collection resource in order to navigate to a specific instance of Resource Shifts 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

• AssignedUnits: number
  Indicates the number of resource instances assigned to the shift.
• ResourceId: integer (int64)
  Indicates the resource to which the shift is assigned.
• ResourceName: string
  Title: Name

  Maximum Length: 80

  Name of the work center resource.
• ShiftId: integer (int64)
  Represents the shift identifier that's the foreign key to the ZMM_SR_SHIFTS_B table that the shift references.
• ShiftName: string
  Maximum Length: 240

  Name of the shift.

{
    "type":"object",
    "properties":{
        "ShiftId":{
            "type":"integer",
            "description":"Represents the shift identifier that's the foreign key to the ZMM_SR_SHIFTS_B table that the shift references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssignedUnits":{
            "type":"number",
            "description":"Indicates the number of resource instances assigned to the shift.",
            "nullable":false
        },
        "ShiftName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the shift.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Indicates the resource to which the shift is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the work center resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : workCenters-productionCalendars-resourceShifts-item-response

Type: object

Show Source

• AssignedUnits: number
  Indicates the number of resource instances assigned to the shift.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Indicates the date and time of the creation of the row.
• LastUpdateDate: string (date-time)
  Read Only: true

  Indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Indicates the session login associated with the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the work center resource.
• ResourceId: integer (int64)
  Indicates the resource to which the shift is assigned.
• ResourceName: string
  Title: Name

  Maximum Length: 80

  Name of the work center resource.
• ShiftId: integer (int64)
  Represents the shift identifier that's the foreign key to the ZMM_SR_SHIFTS_B table that the shift references.
• ShiftName: string
  Maximum Length: 240

  Name of the shift.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the work center resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUnits":{
            "type":"number",
            "description":"Indicates the number of resource instances assigned to the shift.",
            "nullable":false,
            "x-queryable":true
        },
        "ShiftName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the shift.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Indicates the resource to which the shift is assigned.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the work center resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"Represents the shift identifier that's the foreign key to the ZMM_SR_SHIFTS_B table that the shift references.",
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session login associated with the user who last updated the row.",
            "nullable":true,
            "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

Examples

This example describes how to update one resource shift.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workCenters/WorkCenterId/child/productionCalendars/ProductionCalendarId/child/resourceShifts/resourceShiftsUniqID"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/workCenters/300100576699404/child/productionCalendars/300100576699405/child/resourceShifts/00040000000EACED00057708000110F07E2AD7150000000EACED00057708000110F07ECC7A3C0000000EACED00057708000110F09C45640C0000000EACED00057708000110F09C45640D"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "AssignedUnits": 3
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "AssignedUnits": 3,
    "ResourceId": 300100071642901,
    "ResourceName": "M-Oven1",
    "ResourceCode": "M-Oven1",
    "ShiftId": 300100082235964,
    "CreatedBy": "MFG_QA",
    "CreationDate": "2023-07-20T09:32:30.611+00:00",
    "LastUpdateDate": "2023-07-24T07:35:35+00:00",
    "LastUpdateLogin": "0094733EEA4DDE23E0639B6015ACE28D",
    "LastUpdatedBy": "MFG_QA",
    "ShiftName": "SHIFT-B",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workCenters/300100576699404/child/productionCalendars/300100576699405/child/resourceShifts/00040000000EACED00057708000110F07E2AD7150000000EACED00057708000110F07ECC7A3C0000000EACED00057708000110F09C45640C0000000EACED00057708000110F09C45640D",
            "name": "resourceShifts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/workCenters/300100576699404/child/productionCalendars/300100576699405/child/resourceShifts/00040000000EACED00057708000110F07E2AD7150000000EACED00057708000110F07ECC7A3C0000000EACED00057708000110F09C45640C0000000EACED00057708000110F09C45640D",
            "name": "resourceShifts",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/workCenters/300100576699404/child/productionCalendars/300100576699405",
            "name": "productionCalendars",
            "kind": "item"
        }
    ]
}

Back to Top