Jump to

• Request
• Response

Update one shift

patch

/fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/WorkCenterResource/{WorkCenterResourceUniqID}/child/WorkCenterResourceShift/{WorkCenterResourceShiftUniqID}

Request

Path Parameters

• 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.
• WorkCenterResourceShiftUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Shifts for Work Center Resources resource and used to uniquely identify an instance of Shifts for Work Center Resources. The client should not generate the hash key value. Instead, the client should query on the Shifts for Work Center Resources collection resource in order to navigate to a specific instance of Shifts for Work Center Resources to get the hash key.
• WorkCenterResourceUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ResourceId and WorkCenterId ---for the Work Center Resources resource and used to uniquely identify an instance of Work Center Resources. The client should not generate the hash key value. Instead, the client should query on the Work Center Resources collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Center Resources.
  
  For example: WorkCenterResource?q=ResourceId=<value1>;WorkCenterId=<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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignedUnits: number
  Number of resources assigned to the shift.

{
    "type":"object",
    "properties":{
        "AssignedUnits":{
            "type":"number",
            "description":"Number of resources assigned to the shift.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : workCenters-WorkCenterResource-WorkCenterResourceShift-item-response

Type: object

Show Source

• AssignedUnits: number
  Number of resources assigned to the shift.
• Duration: string
  Read Only: true

  Maximum Length: 255

  Duration of the shift.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlantCalendarId: integer
  Read Only: true

  Value that uniquely identifies the plant calendar that the plant calendar references.
• ShiftId: integer (int64)
  Value that uniquely identifies the shift that the shift references.
• ShiftName: string
  Read Only: true

  Name of the shift.
• StartTime: string
  Read Only: true

  Start time of the shift.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center that this work center resource references.

{
    "type":"object",
    "properties":{
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center that this work center resource references.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShiftName":{
            "type":"string",
            "description":"Name of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUnits":{
            "type":"number",
            "description":"Number of resources assigned to the shift.",
            "nullable":false,
            "x-queryable":true
        },
        "PlantCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plant calendar that the plant calendar references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Start time of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift 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"
            }
        },
        "Duration":{
            "maxLength":"255",
            "type":"string",
            "description":"Duration of the shift.",
            "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