Jump to

• Request
• Response

Create status change requests

post

/hcmRestApi/resources/11.13.18.05/statusChangeRequests

Request

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

• requestNumber(required): string
  Maximum Length: 80

  External request number defined by the time consumer application, such as payroll or projects.
• requestStatus: string
  Aggregate status of the current request returned by the application.
• requestTimestamp(required): string
  Maximum Length: 80

  Timestamp for the status change request.
• sourceId(required): string
  Maximum Length: 40

  Identifier for the source.
• statusChanges: array Status Changes
  Title: Status Changes

  The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.
• statusRequestId: integer (int64)
  Unique identifier for the status change request.

{
    "required":[
        "requestNumber",
        "requestTimestamp",
        "sourceId"
    ],
    "type":"object",
    "properties":{
        "sourceId":{
            "maxLength":40,
            "type":"string",
            "description":"Identifier for the source.",
            "nullable":false
        },
        "requestNumber":{
            "maxLength":80,
            "type":"string",
            "description":"External request number defined by the time consumer application, such as payroll or projects.",
            "nullable":false
        },
        "statusChanges":{
            "title":"Status Changes",
            "type":"array",
            "description":"The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.",
            "items":{
                "$ref":"#/components/schemas/statusChangeRequests-statusChanges-item-post-request"
            }
        },
        "requestTimestamp":{
            "maxLength":80,
            "type":"string",
            "description":"Timestamp for the status change request.",
            "nullable":false
        },
        "statusRequestId":{
            "type":"integer",
            "description":"Unique identifier for the status change request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "requestStatus":{
            "type":"string",
            "description":"Aggregate status of the current request returned by the application.",
            "nullable":true
        }
    }
}

Nested Schema : Status Changes

Type: array

Title: Status Changes

The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.

Show Source

• Array of: object statusChangeRequests-statusChanges-item-post-request

{
    "title":"Status Changes",
    "type":"array",
    "description":"The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.",
    "items":{
        "$ref":"#/components/schemas/statusChangeRequests-statusChanges-item-post-request"
    }
}

Nested Schema : statusChangeRequests-statusChanges-item-post-request

Type: object

Show Source

• buildingBlockId: integer (int64)
  Unique identifier for the time record associated with the status change record.
• buildingBlockVersion: integer (int32)
  Version number for the time record stored in the WFM time repository.
• consumerCode: string
  Maximum Length: 30

  Consumer code associated with the status change record, such as PJC or PYR.
• requestStatus: string
  Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.
• statusChangeId: integer (int64)
  Unique identifier for the status change record.
• statusCode: string
  Maximum Length: 40

  Default Value: A_XFR_STATUS

  Status definition ID for the status change record. The default value is A_XFR_STATUS.
• statusValue: string
  Maximum Length: 30

  Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.

{
    "type":"object",
    "properties":{
        "statusChangeId":{
            "type":"integer",
            "description":"Unique identifier for the status change record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "buildingBlockId":{
            "type":"integer",
            "description":"Unique identifier for the time record associated with the status change record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "statusValue":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.",
            "nullable":false
        },
        "consumerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Consumer code associated with the status change record, such as PJC or PYR.",
            "nullable":false
        },
        "buildingBlockVersion":{
            "type":"integer",
            "description":"Version number for the time record stored in the WFM time repository.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "requestStatus":{
            "type":"string",
            "description":"Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.",
            "nullable":true
        },
        "statusCode":{
            "maxLength":40,
            "type":"string",
            "description":"Status definition ID for the status change record. The default value is A_XFR_STATUS.",
            "nullable":false,
            "default":"A_XFR_STATUS"
        }
    }
}

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

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• requestNumber: string
  Maximum Length: 80

  External request number defined by the time consumer application, such as payroll or projects.
• requestStatus: string
  Aggregate status of the current request returned by the application.
• requestTimestamp: string
  Maximum Length: 80

  Timestamp for the status change request.
• sourceId: string
  Maximum Length: 40

  Identifier for the source.
• statusChanges: array Status Changes
  Title: Status Changes

  The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.
• statusRequestId: integer (int64)
  Unique identifier for the status change request.

{
    "type":"object",
    "properties":{
        "sourceId":{
            "maxLength":40,
            "type":"string",
            "description":"Identifier for the source.",
            "nullable":false,
            "x-queryable":true
        },
        "requestNumber":{
            "maxLength":80,
            "type":"string",
            "description":"External request number defined by the time consumer application, such as payroll or projects.",
            "nullable":false,
            "x-queryable":true
        },
        "requestTimestamp":{
            "maxLength":80,
            "type":"string",
            "description":"Timestamp for the status change request.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "statusChanges":{
            "title":"Status Changes",
            "type":"array",
            "description":"The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.",
            "items":{
                "$ref":"#/components/schemas/statusChangeRequests-statusChanges-item-response"
            }
        },
        "statusRequestId":{
            "type":"integer",
            "description":"Unique identifier for the status change request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "requestStatus":{
            "type":"string",
            "description":"Aggregate status of the current request returned by the application.",
            "nullable":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 : Status Changes

Type: array

Title: Status Changes

The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.

Show Source

• Array of: object statusChangeRequests-statusChanges-item-response

{
    "title":"Status Changes",
    "type":"array",
    "description":"The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.",
    "items":{
        "$ref":"#/components/schemas/statusChangeRequests-statusChanges-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 : statusChangeRequests-statusChanges-item-response

Type: object

Show Source

• buildingBlockId: integer (int64)
  Unique identifier for the time record associated with the status change record.
• buildingBlockVersion: integer (int32)
  Version number for the time record stored in the WFM time repository.
• consumerCode: string
  Maximum Length: 30

  Consumer code associated with the status change record, such as PJC or PYR.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• requestStatus: string
  Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.
• statusChangeId: integer (int64)
  Unique identifier for the status change record.
• statusCode: string
  Maximum Length: 40

  Default Value: A_XFR_STATUS

  Status definition ID for the status change record. The default value is A_XFR_STATUS.
• statusValue: string
  Maximum Length: 30

  Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.

{
    "type":"object",
    "properties":{
        "statusChangeId":{
            "type":"integer",
            "description":"Unique identifier for the status change record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "buildingBlockId":{
            "type":"integer",
            "description":"Unique identifier for the time record associated with the status change record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "statusValue":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "consumerCode":{
            "maxLength":30,
            "type":"string",
            "description":"Consumer code associated with the status change record, such as PJC or PYR.",
            "nullable":false,
            "x-queryable":true
        },
        "buildingBlockVersion":{
            "type":"integer",
            "description":"Version number for the time record stored in the WFM time repository.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "requestStatus":{
            "type":"string",
            "description":"Processing status for the status change record, such as NEW, IN PROCESS, or COMPLETE.",
            "nullable":true,
            "x-queryable":true
        },
        "statusCode":{
            "maxLength":40,
            "type":"string",
            "description":"Status definition ID for the status change record. The default value is A_XFR_STATUS.",
            "nullable":false,
            "default":"A_XFR_STATUS",
            "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"
    }
}

Links

statusChanges

Operation: /hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges

Parameters:

• statusRequestId: $request.path.statusRequestId

The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.

Back to Top