Jump to

• Request
• Response

Update one detail

patch

/fscmRestApi/resources/11.13.18.05/shifts/{ShiftId}/child/shiftDetails/{ShiftDetailsId}

Request

Path Parameters

• ShiftDetailsId(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=
• ShiftId(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=

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CoreWorkFlag: boolean
  Title: Core Work

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the shift detail is core working time. If false, then the shift detail isn't core working time. The default value is false.
• Day: integer
  The day of the shift detail when shifts are longer than 24 hours in length.
• Duration: number
  The value that identifies the duration of the shift detail.
• DurationUnit: string
  Title: Duration Unit

  Maximum Length: 30

  The unit of time associated with the time-duration value. Valid values are DAYS, HOURS, MINUTES, and WEEKS.
• DurationUnitName: string
  Title: Meaning

  Maximum Length: 80

  The name of the unit of time to associate with the time-duration value.
• MaximumBreakMinutes: integer
  The maximum number of minutes that you may take as a break in the shift detail.
• MinimumBreakMinutes: integer
  The minimum number of minutes that you may take as a break in the shift detail.
• Name: string
  Title: Name

  Maximum Length: 30

  The code for the shift detail type. Valid values for punch shifts are IN, OUT, BREAK, MEAL, and TRANSFER. Valid values for flexible shifts are CORE_WORK, FLEX_END, FLEX_MEAL, and FLEX_START.
• ShiftDetailName: string
  Title: Meaning

  Maximum Length: 80

  The display name of the type of shift detail being created.
• StartTime: string
  The time when the shift detail starts. The text is formatted as hh:mm AM or PM.

{
    "type":"object",
    "properties":{
        "CoreWorkFlag":{
            "title":"Core Work",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shift detail is core working time. If false, then the shift detail isn't core working time. The default value is false.",
            "nullable":false,
            "default":false
        },
        "Day":{
            "type":"integer",
            "description":"The day of the shift detail when shifts are longer than 24 hours in length.",
            "nullable":true
        },
        "Duration":{
            "type":"number",
            "description":"The value that identifies the duration of the shift detail.",
            "nullable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time associated with the time-duration value. Valid values are DAYS, HOURS, MINUTES, and WEEKS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DurationUnitName"
                ]
            }
        },
        "DurationUnitName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The name of the unit of time to associate with the time-duration value.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MaximumBreakMinutes":{
            "type":"integer",
            "description":"The maximum number of minutes that you may take as a break in the shift detail.",
            "nullable":true
        },
        "MinimumBreakMinutes":{
            "type":"integer",
            "description":"The minimum number of minutes that you may take as a break in the shift detail.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The code for the shift detail type. Valid values for punch shifts are IN, OUT, BREAK, MEAL, and TRANSFER. Valid values for flexible shifts are CORE_WORK, FLEX_END, FLEX_MEAL, and FLEX_START.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ShiftDetailName"
                ]
            }
        },
        "ShiftDetailName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The display name of the type of shift detail being created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartTime":{
            "type":"string",
            "description":"The time when the shift detail starts. The text is formatted as hh:mm AM or PM.",
            "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:
  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 : shifts-shiftDetails-item-response

Type: object

Show Source

• CoreWorkFlag: boolean
  Title: Core Work

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the shift detail is core working time. If false, then the shift detail isn't core working time. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the record.
• Day: integer
  The day of the shift detail when shifts are longer than 24 hours in length.
• Duration: number
  The value that identifies the duration of the shift detail.
• DurationUnit: string
  Title: Duration Unit

  Maximum Length: 30

  The unit of time associated with the time-duration value. Valid values are DAYS, HOURS, MINUTES, and WEEKS.
• DurationUnitName: string
  Title: Meaning

  Maximum Length: 80

  The name of the unit of time to associate with the time-duration value.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• MaximumBreakMinutes: integer
  The maximum number of minutes that you may take as a break in the shift detail.
• MinimumBreakMinutes: integer
  The minimum number of minutes that you may take as a break in the shift detail.
• Name: string
  Title: Name

  Maximum Length: 30

  The code for the shift detail type. Valid values for punch shifts are IN, OUT, BREAK, MEAL, and TRANSFER. Valid values for flexible shifts are CORE_WORK, FLEX_END, FLEX_MEAL, and FLEX_START.
• ShiftDetailName: string
  Title: Meaning

  Maximum Length: 80

  The display name of the type of shift detail being created.
• ShiftDetailsId: integer (int64)
  Read Only: true

  The value that uniquely identifies the shift detail. It's a primary key that the application generates when it creates a shift detail. This attribute is required.
• StartTime: string
  The time when the shift detail starts. The text is formatted as hh:mm AM or PM.

{
    "type":"object",
    "properties":{
        "CoreWorkFlag":{
            "title":"Core Work",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the shift detail is core working time. If false, then the shift detail isn't core working time. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Day":{
            "type":"integer",
            "description":"The day of the shift detail when shifts are longer than 24 hours in length.",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "description":"The value that identifies the duration of the shift detail.",
            "nullable":true,
            "x-queryable":true
        },
        "DurationUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of time associated with the time-duration value. Valid values are DAYS, HOURS, MINUTES, and WEEKS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DurationUnitName"
                ]
            },
            "x-queryable":true
        },
        "DurationUnitName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The name of the unit of time to associate with the time-duration value.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumBreakMinutes":{
            "type":"integer",
            "description":"The maximum number of minutes that you may take as a break in the shift detail.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumBreakMinutes":{
            "type":"integer",
            "description":"The minimum number of minutes that you may take as a break in the shift detail.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The code for the shift detail type. Valid values for punch shifts are IN, OUT, BREAK, MEAL, and TRANSFER. Valid values for flexible shifts are CORE_WORK, FLEX_END, FLEX_MEAL, and FLEX_START.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ShiftDetailName"
                ]
            },
            "x-queryable":true
        },
        "ShiftDetailName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The display name of the type of shift detail being created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShiftDetailsId":{
            "type":"integer",
            "description":"The value that uniquely identifies the shift detail. It's a primary key that the application generates when it creates a shift detail. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"The time when the shift detail starts. The text is formatted as hh:mm AM or PM.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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