Jump to

• Request
• Response

Get an assignment status

get

/hcmRestApi/resources/11.13.18.05/assignmentStatuses/{AssignmentStatusTypeId}

Request

Path Parameters

• AssignmentStatusTypeId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : assignmentStatuses-item-response

Type: object

Show Source

• AssignmentStatusCode: string
  Title: Code

  Maximum Length: 30

  Assignment status code of assignment statuses.
• AssignmentStatusTypeId: integer (int64)
  Title: Assignment Status ID

  Assignment status type identifier of assignment statuses.
• BusinessGroupId: integer (int64)
  Title: Business Group ID

  Business group identifier of assignment statuses.
• Country: string
  Title: Country

  Maximum Length: 2000

  Country of assignment statuses.
• Default: string
  Title: Default

  Maximum Length: 30

  Default Value: N

  Indicates whether the assignment status is the default value.
• EndDate: string (date)
  Title: End Date

  End date of assignment statuses.
• HRStatus: string
  Title: HR Status

  Maximum Length: 30

  HR status of assignment statuses.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrigAssignStatusTypeId: integer
  Title: Original Status

  Original assignment status type identifier of assignment statuses.
• PayStatus: string
  Title: Pay Status

  Maximum Length: 30

  Pay status of assignment statuses.
• StartDate: string (date)
  Title: Start Date

  Start date of assignment statuses.
• translations: array Assignment Status Translations
  Title: Assignment Status Translations

  The assignmentStatuses translations resource provides translated details of the assignment statuses.
• UserStatus: string
  Title: Status

  Maximum Length: 80

  User status of assignment statuses.

{
    "type":"object",
    "properties":{
        "AssignmentStatusCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"Assignment status code of assignment statuses.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignmentStatusTypeId":{
            "title":"Assignment Status ID",
            "type":"integer",
            "description":"Assignment status type identifier of assignment statuses.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessGroupId":{
            "title":"Business Group ID",
            "type":"integer",
            "description":"Business group identifier of assignment statuses.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2000,
            "type":"string",
            "description":"Country of assignment statuses.",
            "nullable":true,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            },
            "x-queryable":true
        },
        "Default":{
            "title":"Default",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the assignment status is the default value.",
            "nullable":false,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of assignment statuses.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HRStatus":{
            "title":"HR Status",
            "maxLength":30,
            "type":"string",
            "description":"HR status of assignment statuses.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrigAssignStatusTypeId":{
            "title":"Original Status",
            "type":"integer",
            "description":"Original assignment status type identifier of assignment statuses.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayStatus":{
            "title":"Pay Status",
            "maxLength":30,
            "type":"string",
            "description":"Pay status of assignment statuses.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of assignment statuses.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UserStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"User status of assignment statuses.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "translations":{
            "title":"Assignment Status Translations",
            "type":"array",
            "description":"The assignmentStatuses translations resource provides translated details of the assignment statuses.",
            "items":{
                "$ref":"#/components/schemas/assignmentStatuses-translations-item-response"
            }
        }
    }
}

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 : Assignment Status Translations

Type: array

Title: Assignment Status Translations

The assignmentStatuses translations resource provides translated details of the assignment statuses.

Show Source

• Array of: object assignmentStatuses-translations-item-response

{
    "title":"Assignment Status Translations",
    "type":"array",
    "description":"The assignmentStatuses translations resource provides translated details of the assignment statuses.",
    "items":{
        "$ref":"#/components/schemas/assignmentStatuses-translations-item-response"
    }
}

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."
        }
    }
}

Nested Schema : assignmentStatuses-translations-item-response

Type: object

Show Source

• AssignmentStatusTypeId: integer (int64)
  Assignment status type identifier of assignment status translations.
• Language: string
  Maximum Length: 4

  Language code of assignment status translations.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Object version number of assignment status translations.
• SourceLang: string
  Maximum Length: 4

  Source language of assignment status translations.
• UserStatus: string
  Title: Status

  Maximum Length: 80

  User status of assignment status translations.

{
    "type":"object",
    "properties":{
        "AssignmentStatusTypeId":{
            "type":"integer",
            "description":"Assignment status type identifier of assignment status translations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language code of assignment status translations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of assignment status translations.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of assignment status translations.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"User status of assignment status translations.",
            "nullable":false,
            "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"
    }
}

Links

AssignmentStatusTypeLovVO

Operation: /hcmRestApi/resources/11.13.18.05/assignmentStatusTypesLov

Parameters:

• finder: findSeededAsignmentStatus

The following properties are defined on the LOV link relation:

• Source Attribute: OrigAssignStatusTypeId; Target Attribute: AssignmentStatusTypeId
• Display Attribute: UserStatus

HrLookupHRStatus

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPER_ASS_SYS_STATUS

The following properties are defined on the LOV link relation:

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

HrLookupPayStatus

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DPAY_ASS_SYS_STATUS

The following properties are defined on the LOV link relation:

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

HrLookupYesNo

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

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

RestCountryLovVO

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryCode
• Display Attribute: TerritoryCode, CountryName

translations

Operation: /hcmRestApi/resources/11.13.18.05/assignmentStatuses/{AssignmentStatusTypeId}/child/translations

Parameters:

• AssignmentStatusTypeId: $request.path.AssignmentStatusTypeId

The assignmentStatuses translations resource provides translated details of the assignment statuses.

Back to Top