Jump to

• Request
• Response
• Examples

Create an assignment manager

post

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

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>
• 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:
  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:
  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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Maximum Length: 80

  Action being performed on the assignment such as Hire, Add Pending Worker, Manager Change and so on. Valid values are defined in the actionsLOV.
• 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.
• ManagerAssignmentId: integer (int64)
  Title: Assignment ID

  Surrogate identifier for the assignment supervisor.
• ManagerAssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Assignment number of the supervisor.
• ManagerType: string
  Title: Type

  Maximum Length: 30

  Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.
• ReasonCode: string
  Title: Reason Code

  Maximum Length: 80

  Reason for the change. Valid values are defined in the actionReasonsLOV.

{
    "type":"object",
    "properties":{
        "ManagerAssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the supervisor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "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
            }
        },
        "ManagerType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "ActionCode":{
            "title":"Action Code",
            "maxLength":80,
            "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
            }
        },
        "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",
            "maxLength":80,
            "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
            }
        },
        "ManagerAssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Surrogate identifier for the assignment supervisor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        }
    }
}

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-managers-item-response

Type: object

Show Source

• ActionCode: string
  Title: Action Code

  Maximum Length: 80

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

  Read Only: true

  Surrogate identifier for the supervisor of the worker assignment.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Date and time when the supervisor record 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

  User who last updated the supervisor record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Date and time when the supervisor record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerAssignmentId: integer (int64)
  Title: Assignment ID

  Surrogate identifier for the assignment supervisor.
• ManagerAssignmentNumber: string
  Title: Assignment Number

  Maximum Length: 30

  Assignment number of the supervisor.
• ManagerType: string
  Title: Type

  Maximum Length: 30

  Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.
• ManagerTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning for person's manager type.
• ReasonCode: string
  Title: Reason Code

  Maximum Length: 80

  Reason for the change. Valid values are defined in the actionReasonsLOV.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Date and time when the supervisor record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the supervisor record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supervisor record.",
            "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
        },
        "ManagerType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Role the supervisor has with regards to the overall organization structure such as functional, project leader, and so on. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ActionCode":{
            "title":"Action Code",
            "maxLength":80,
            "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
            }
        },
        "ReasonCode":{
            "title":"Reason Code",
            "maxLength":80,
            "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
            }
        },
        "ManagerAssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Surrogate identifier for the assignment supervisor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentSupervisorId":{
            "title":"Assignment Supervisor ID",
            "type":"integer",
            "description":"Surrogate identifier for the supervisor of the worker assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ManagerTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning for person's manager type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ManagerAssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":30,
            "type":"string",
            "description":"Assignment number of the supervisor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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":"User who last updated the supervisor record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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."
        }
    }
}

Links

actionReasonsLOV

Operation: /hcmRestApi/resources/11.13.18.05/actionReasonsLOV

Parameters:

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

The list of values for action reasons.

actionsLOV

Operation: /hcmRestApi/resources/11.13.18.05/actionsLOV

The list of values for actions.

managerTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupType%3DPER_SUPERVISOR_TYPE%2CLegislationCode%3D{LegislationCode}%2CLookupCode%3D{ManagerType}

The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.

Back to Top

Examples

The following example shows how to create an assignment manager by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -H "Effective-Of:RangeStartDate=2018-01-01" -X POST -d <payload> "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED00057708000110F086BB19F10000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001627E80E80078/child/workRelationships/300100215314932/child/assignments/00020000000EACED00057708000110F084F0BA020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B59741903000078707708000001614EA9B40078/child/managers"

Example of Payload

The following is an example of the payload.

{
   "ManagerAssignmentId": 300100185275263, 
   "ManagerAssignmentNumber": "E955160008193928", 
   "ManagerType": "LINE_MANAGER", 
   "ActionCode": "HIRE", 
   "ReasonCode": null
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "AssignmentSupervisorId": 605745,
    "EffectiveStartDate": "2018-02-01",
    "EffectiveEndDate": "4712-12-31",
    "ManagerAssignmentId": 300100185275263,
    "ManagerAssignmentNumber": "E955160008193928",
    "ManagerType": "LINE_MANAGER",
    "ActionCode": "HIRE",
    "ReasonCode": null,
    "CreatedBy": "HCM_INTEGRATION_SPEC",
    "CreationDate": "2019-04-23T11:17:22+00:00",
    "LastUpdatedBy": "HCM_INTEGRATION_SPEC",
    "LastUpdateDate": "2019-04-23T11:17:23.728+00:00",
    "links": [
        {...
          }
   ]
}

Back to Top