Jump to

• Request
• Response

Update an assignment work measure

patch

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}

Request

Path Parameters

• PeriodOfServiceId(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=
• assignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AssignmentId, EffectiveStartDate, EffectiveEndDate, EffectiveSequence and EffectiveLatestChange ---for the Assignments resource and used to uniquely identify an instance of Assignments. The client should not generate the hash key value. Instead, the client should query on the Assignments collection resource with a filter on the primary key values in order to navigate to a specific instance of Assignments.
  
  For example: assignments?q=AssignmentId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>;EffectiveSequence=<value4>;EffectiveLatestChange=<value5>
• workMeasuresUniqID(required): string
  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=
• workersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• ActionCode: string
  Title: Action Code

  Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
• CalculateWorkmeasureFlag: boolean
  Title: Calculate FTE and Headcount Automatically

  Maximum Length: 30

  Indicates whether the full time equivalency (FTE) should be calculated automatically.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  End date of the date-effective changes to the record.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Start date of the date-effective changes to the record.
• ReasonCode: string
  Title: Reason Code

  Reason for the change.Valid values are defined in the actionReasonsLOV.
• Value: number
  Title: Value

  Value of the work measure.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "title":"Action Code",
            "type":"string",
            "description":"Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "CalculateWorkmeasureFlag":{
            "title":"Calculate FTE and Headcount Automatically",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the full time equivalency (FTE) should be calculated automatically.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"End date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Start date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReasonCode":{
            "title":"Reason Code",
            "type":"string",
            "description":"Reason for the change.Valid values are defined in the actionReasonsLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "Value":{
            "title":"Value",
            "type":"number",
            "description":"Value of the work measure.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":30,
                "scale":10
            }
        }
    }
}

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 : workers-workRelationships-assignments-workMeasures-item-response

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
• AssignWorkMeasureId: integer (int64)
  Title: Assignment Work Measure ID

  Read Only: true

  Surrogate identifier for the assignment work measure.
• CalculateWorkmeasureFlag: boolean
  Title: Calculate FTE and Headcount Automatically

  Maximum Length: 30

  Indicates whether the full time equivalency (FTE) should be calculated automatically.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date and time when the work measure was created.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  End date of the date-effective changes to the record.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Start date of the date-effective changes to the record.
• LastUpdateDate: string (date-time)
  Title: Last Changed Date

  Read Only: true

  Date and time when the work measure was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the work measure.
• links: array Links
  Title: Links

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

  Reason for the change.Valid values are defined in the actionReasonsLOV.
• Unit: string
  Title: Unit

  Maximum Length: 30

  Unit of measure. Valid values are defined in the commonLookupsLOV.
• UnitMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the person's unit code.
• Value: number
  Title: Value

  Value of the work measure.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "title":"Action Code",
            "type":"string",
            "description":"Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "AssignWorkMeasureId":{
            "title":"Assignment Work Measure ID",
            "type":"integer",
            "description":"Surrogate identifier for the assignment work measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "CalculateWorkmeasureFlag":{
            "title":"Calculate FTE and Headcount Automatically",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the full time equivalency (FTE) should be calculated automatically.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the work measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the work measure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"End date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Start date of the date-effective changes to the record.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Changed Date",
            "type":"string",
            "description":"Date and time when the work measure was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the work measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ReasonCode":{
            "title":"Reason Code",
            "type":"string",
            "description":"Reason for the change.Valid values are defined in the actionReasonsLOV.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "Unit":{
            "title":"Unit",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UnitMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the person's unit code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Value":{
            "title":"Value",
            "type":"number",
            "description":"Value of the work measure.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":30,
                "scale":10
            }
        },
        "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."
        }
    }
}

Links

actionReasonsLOV

Operation: /hcmRestApi/resources/11.13.18.05/actionReasonsLOV

Parameters:

• finder: findByActionId%3BActionId%3D{ActionId}

The following properties are defined on the LOV link relation:

• Source Attribute: ReasonCode; Target Attribute: ActionReasonCode
• Display Attribute: ActionReason

actionsLOV

Operation: /hcmRestApi/resources/11.13.18.05/actionsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ActionCode; Target Attribute: ActionCode
• Display Attribute: ActionName

unitsLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupType%3DBUDGET_MEASUREMENT_TYPE%2CLegislationCode%3D{LegislationCode}%2CLookupCode%3D{Unit}

The following properties are defined on the LOV link relation:

• Source Attribute: Unit; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top