Jump to

• Request
• Response

Update a journey assignment

patch

/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}

Request

Path Parameters

• journeyAllocationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Journey Allocations resource and used to uniquely identify an instance of Journey Allocations. The client should not generate the hash key value. Instead, the client should query on the Journey Allocations collection resource in order to navigate to a specific instance of Journey Allocations to get the hash key.

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

• criteria: array Criteria
  Title: Criteria

  The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.
• EndDate: string (date)
  Date when the journey assignment ends.
• workerCounts: array Worker Counts
  Title: Worker Counts

  The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.
• workers: array Workers
  Title: Workers

  The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "type":"string",
            "description":"Date when the journey assignment ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "criteria":{
            "title":"Criteria",
            "type":"array",
            "description":"The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.",
            "items":{
                "$ref":"#/components/schemas/journeyAllocations-criteria-item-patch-request"
            }
        },
        "workerCounts":{
            "title":"Worker Counts",
            "type":"array",
            "description":"The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.",
            "items":{
                "$ref":"#/components/schemas/journeyAllocations-workerCounts-item-patch-request"
            }
        },
        "workers":{
            "title":"Workers",
            "type":"array",
            "description":"The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.",
            "items":{
                "$ref":"#/components/schemas/journeyAllocations-workers-item-patch-request"
            }
        }
    }
}

Nested Schema : Criteria

Type: array

Title: Criteria

The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.

Show Source

• Array of: object schema

{
    "title":"Criteria",
    "type":"array",
    "description":"The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.",
    "items":{
        "$ref":"#/components/schemas/journeyAllocations-criteria-item-patch-request"
    }
}

Nested Schema : Worker Counts

Type: array

Title: Worker Counts

The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.

Show Source

• Array of: object journeyAllocations-workerCounts-item-patch-request

{
    "title":"Worker Counts",
    "type":"array",
    "description":"The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.",
    "items":{
        "$ref":"#/components/schemas/journeyAllocations-workerCounts-item-patch-request"
    }
}

Nested Schema : Workers

Type: array

Title: Workers

The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.

Show Source

• Array of: object journeyAllocations-workers-item-patch-request

{
    "title":"Workers",
    "type":"array",
    "description":"The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.",
    "items":{
        "$ref":"#/components/schemas/journeyAllocations-workers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : journeyAllocations-workerCounts-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : journeyAllocations-workers-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• AssignedDate: string (date)
  Date when the journey was assigned.
• Comments: string
  Maximum Length: 4000

  Comments provided for the journey assignment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the journey assignment.
• CreationDate: string (date-time)
  Read Only: true

  Date when the journey assignment is created.
• criteria: array Criteria
  Title: Criteria

  The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.
• EndDate: string (date)
  Date when the journey assignment ends.
• InitiationDate: string (date)
  Read Only: true

  Date when the journey allocation is initiated.
• InitiatorDisplayName: string
  Read Only: true

  Maximum Length: 240

  Name of the person who initiated the journey assignment.
• InitiatorPersonId: integer (int64)
  Read Only: true

  Unique identifier of the person who initiated the journey assignment.
• InitiatorPersonNumber: string
  Read Only: true

  Maximum Length: 30

  Person number of the person who initiated the journey assignment.
• JourneyAllocationId: integer (int64)
  Read Only: true

  Unique identifier of the journey assignment.
• JourneyCategory: string
  Title: Category

  Read Only: true

  Maximum Length: 60

  Category of the journey.
• JourneyCategoryMeaning: string
  Read Only: true

  Meaning of journey category.
• JourneyId: integer (int64)
  Unique identifier of the journey.
• JourneyName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the journey.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the journey assignment was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the journey assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Read Only: true

  Maximum Length: 4000

  Name of the activity.
• PopulationCount: integer (int32)
  Read Only: true

  Default Value: -1

  Number of users the journey is assigned to.
• ProcessingStatus: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_PENDING

  Processing status of the journey assignment.
• ProcessingStatusMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the processing status for an assigned journey.
• Source: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_MANUAL

  Source of journey assignment.
• SourceMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Source meaning of journey assignment.
• StatusCategory: string
  Read Only: true

  Maximum Length: 80

  Status category of journey assignment.
• StatusCategoryMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status category meaning of journey assignment.
• SubmitFlag: boolean
  Default Value: true

  Indicates whether the journey assignment is submitted. Valid values are true (enabled) and false (disabled). The default value is false (disabled).
• workerCounts: array Worker Counts
  Title: Worker Counts

  The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.
• workers: array Workers
  Title: Workers

  The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.

{
    "type":"object",
    "properties":{
        "AssignedDate":{
            "type":"string",
            "description":"Date when the journey was assigned.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments provided for the journey assignment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the journey assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the journey assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the journey assignment ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InitiationDate":{
            "type":"string",
            "description":"Date when the journey allocation is initiated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "InitiatorDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who initiated the journey assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InitiatorPersonId":{
            "type":"integer",
            "description":"Unique identifier of the person who initiated the journey assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "InitiatorPersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person who initiated the journey assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyAllocationId":{
            "type":"integer",
            "description":"Unique identifier of the journey assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "JourneyCategory":{
            "title":"Category",
            "maxLength":60,
            "type":"string",
            "description":"Category of the journey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JourneyCategoryMeaning":{
            "type":"string",
            "description":"Meaning of journey category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyId":{
            "type":"integer",
            "description":"Unique identifier of the journey.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "JourneyName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the journey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the journey assignment was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the journey assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PopulationCount":{
            "type":"integer",
            "description":"Number of users the journey is assigned to.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":-1,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":9
            }
        },
        "ProcessingStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status of the journey assignment.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_PENDING",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProcessingStatusMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the processing status for an assigned journey.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Source":{
            "maxLength":30,
            "type":"string",
            "description":"Source of journey assignment.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_MANUAL",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SourceMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Source meaning of journey assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCategory":{
            "maxLength":80,
            "type":"string",
            "description":"Status category of journey assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StatusCategoryMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status category meaning of journey assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SubmitFlag":{
            "type":"boolean",
            "description":"Indicates whether the journey assignment is submitted. Valid values are true (enabled) and false (disabled). The default value is false (disabled).",
            "nullable":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "criteria":{
            "title":"Criteria",
            "type":"array",
            "description":"The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.",
            "items":{
                "$ref":"#/components/schemas/journeyAllocations-criteria-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "workerCounts":{
            "title":"Worker Counts",
            "type":"array",
            "description":"The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.",
            "items":{
                "$ref":"#/components/schemas/journeyAllocations-workerCounts-item-response"
            }
        },
        "workers":{
            "title":"Workers",
            "type":"array",
            "description":"The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.",
            "items":{
                "$ref":"#/components/schemas/journeyAllocations-workers-item-response"
            }
        }
    }
}

Nested Schema : Criteria

Type: array

Title: Criteria

The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.

Show Source

• Array of: object journeyAllocations-criteria-item-response

{
    "title":"Criteria",
    "type":"array",
    "description":"The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.",
    "items":{
        "$ref":"#/components/schemas/journeyAllocations-criteria-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 : Worker Counts

Type: array

Title: Worker Counts

The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.

Show Source

• Array of: object journeyAllocations-workerCounts-item-response

{
    "title":"Worker Counts",
    "type":"array",
    "description":"The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.",
    "items":{
        "$ref":"#/components/schemas/journeyAllocations-workerCounts-item-response"
    }
}

Nested Schema : Workers

Type: array

Title: Workers

The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.

Show Source

• Array of: object journeyAllocations-workers-item-response

{
    "title":"Workers",
    "type":"array",
    "description":"The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.",
    "items":{
        "$ref":"#/components/schemas/journeyAllocations-workers-item-response"
    }
}

Nested Schema : journeyAllocations-criteria-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Assignment identifier criteria in journey assignment.
• AssignmentName: string
  Read Only: true

  Maximum Length: 255

  Assignment name criteria in journey assignment.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 255

  Assignment number criteria in journey assignment.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the journey assignment criteria.
• CreationDate: string (date-time)
  Read Only: true

  Date when the journey assignment criteria is created.
• CriteriaCondition: string
  Maximum Length: 4000

  Condition of the criteria of the scheduled journey allocation.
• DisplayName: string
  Read Only: true

  Maximum Length: 240

  Name of the person who provided journey assignment criteria.
• ExcludeFlag: boolean
  Read Only: true

  Maximum Length: 4

  Default Value: false

  Indicates whether a journey assignment based on a criteria needs to be excluded. Valid values are true (enabled) and false (disabled). The default value is false (disabled).
• JourneyAllocationCriteriaId: integer (int64)
  Read Only: true

  Unique identifier of the journey assignment criteria.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which the journey assignment criteria was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the journey assignment criteria.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListId: integer (int64)
  List identifier of the criteria of the journey schedule allocation generated by the application.
• ListName: string
  Read Only: true

  Maximum Length: 200

  Display name of the list used in the criteria of the scheduled journey allocation.
• PersonId: integer (int64)
  Unique identifier of the person who provided the journey assignment criteria.
• ProcessedFlag: boolean
  Read Only: true

  Maximum Length: 4

  Default Value: false

  Indicates whether the journey assignment based on criteria is processed. Valid values are true (enabled) and false (disabled). The default value is false (disabled).
• Type: string
  Maximum Length: 30

  Default Value: ORA_PERSON

  Journey assignment criteria type.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of type in journey assignment criteria.

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment identifier criteria in journey assignment.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AssignmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment name criteria in journey assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment number criteria in journey assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the journey assignment criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the journey assignment criteria is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CriteriaCondition":{
            "maxLength":4000,
            "type":"string",
            "description":"Condition of the criteria of the scheduled journey allocation.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who provided journey assignment criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ExcludeFlag":{
            "maxLength":4,
            "type":"boolean",
            "description":"Indicates whether a journey assignment based on a criteria needs to be excluded. Valid values are true (enabled) and false (disabled). The default value is false (disabled).",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "JourneyAllocationCriteriaId":{
            "type":"integer",
            "description":"Unique identifier of the journey assignment criteria.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which the journey assignment criteria was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the journey assignment criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ListId":{
            "type":"integer",
            "description":"List identifier of the criteria of the journey schedule allocation generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ListName":{
            "maxLength":200,
            "type":"string",
            "description":"Display name of the list used in the criteria of the scheduled journey allocation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person who provided the journey assignment criteria.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "ProcessedFlag":{
            "maxLength":4,
            "type":"boolean",
            "description":"Indicates whether the journey assignment based on criteria is processed. Valid values are true (enabled) and false (disabled). The default value is false (disabled).",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "Type":{
            "maxLength":30,
            "type":"string",
            "description":"Journey assignment criteria type.",
            "nullable":false,
            "default":"ORA_PERSON",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of type in journey assignment criteria.",
            "nullable":false,
            "readOnly":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."
        }
    }
}

Nested Schema : journeyAllocations-workerCounts-item-response

Type: object

Show Source

• CompletedWorkers: integer
  Read Only: true

  Count of workers for whom journey assignment completed.
• FailedWorkers: integer
  Read Only: true

  Count of workers for whom journey assignment failed.
• JourneyAllocationId: integer
  Read Only: true

  Unique identifier of the journey assignment count.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PendingWorkers: integer
  Read Only: true

  Count of workers for whom journey assignment is pending.
• TotalWorkers: integer
  Read Only: true

  Total count of workers for whom journey assignment is processed.

{
    "type":"object",
    "properties":{
        "CompletedWorkers":{
            "type":"integer",
            "description":"Count of workers for whom journey assignment completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FailedWorkers":{
            "type":"integer",
            "description":"Count of workers for whom journey assignment failed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyAllocationId":{
            "type":"integer",
            "description":"Unique identifier of the journey assignment count.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PendingWorkers":{
            "type":"integer",
            "description":"Count of workers for whom journey assignment is pending.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalWorkers":{
            "type":"integer",
            "description":"Total count of workers for whom journey assignment is processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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 : journeyAllocations-workers-item-response

Type: object

Show Source

• AllocationDetails: string
  Read Only: true

  Maximum Length: 1000

  Assignment details for worker to whom journey is assigned.
• AllocationStatus: string
  Read Only: true

  Maximum Length: 30

  Assignment status for worker to whom journey is assigned.
• AllocationStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Assignment status meaning for worker to whom journey is assigned.
• AssignmentId: integer (int64)
  Read Only: true

  Assignment identifier of worker to whom journey is assigned.
• AssignmentName: string
  Read Only: true

  Maximum Length: 80

  Assignment name of worker to whom journey is assigned.
• AssignmentNumber: string
  Read Only: true

  Maximum Length: 50

  Assignment number of worker to whom journey is assigned.
• DisplayName: string
  Read Only: true

  Maximum Length: 240

  Display name of worker to whom journey is assigned.
• ErrorDetails: string (byte)
  Read Only: true

  Details of error for a worker to whom journey is assigned.
• JourneyAllocationWorkerId: integer (int64)
  Read Only: true

  Unique identifier of the worker to whom journey is assigned.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Read Only: true

  Unique identifier of the person to whom journey is assigned.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  Person number of the person to whom journey is assigned.
• ProcessingStatus: string
  Read Only: true

  Maximum Length: 30

  Processing status of the journey assignment for a worker.
• ProcessingStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  Processing status meaning of the journey assignment for a worker.

{
    "type":"object",
    "properties":{
        "AllocationDetails":{
            "maxLength":1000,
            "type":"string",
            "description":"Assignment details for worker to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AllocationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Assignment status for worker to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AllocationStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Assignment status meaning for worker to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment identifier of worker to whom journey is assigned.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "AssignmentName":{
            "maxLength":80,
            "type":"string",
            "description":"Assignment name of worker to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Assignment number of worker to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"Display name of worker to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDetails":{
            "type":"string",
            "description":"Details of error for a worker to whom journey is assigned.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyAllocationWorkerId":{
            "type":"integer",
            "description":"Unique identifier of the worker to whom journey is assigned.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person to whom journey is assigned.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person to whom journey is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessingStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status of the journey assignment for a worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ProcessingStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Processing status meaning of the journey assignment for a worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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

criteria

Operation: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria

Parameters:

• journeyAllocationsUniqID: $request.path.journeyAllocationsUniqID

The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.

workerCounts

Operation: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCounts

Parameters:

• journeyAllocationsUniqID: $request.path.journeyAllocationsUniqID

The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.

workers

Operation: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers

Parameters:

• journeyAllocationsUniqID: $request.path.journeyAllocationsUniqID

The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.

Back to Top