Jump to

• Request
• Response

Create all task types in a journey template

patch

/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}

Request

Path Parameters

• Code(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• JourneyId(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=

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

• Code: string
  Maximum Length: 61

  Code of the journey template task type property.
• JourneyId: integer
  Identifier of the journey template task type property.
• properties: array Properties
  Title: Properties

  The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.

{
    "type":"object",
    "properties":{
        "Code":{
            "maxLength":61,
            "type":"string",
            "description":"Code of the journey template task type property.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "JourneyId":{
            "type":"integer",
            "description":"Identifier of the journey template task type property.",
            "nullable":true
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-taskTypes-properties-item-patch-request"
            }
        }
    }
}

Nested Schema : Properties

Type: array

Title: Properties

The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.

Show Source

• Array of: object journeys-taskTypes-properties-item-patch-request

{
    "title":"Properties",
    "type":"array",
    "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/journeys-taskTypes-properties-item-patch-request"
    }
}

Nested Schema : journeys-taskTypes-properties-item-patch-request

Type: object

Show Source

• Category: string
  Category of the journey template task type property.
• CategoryMeaning: string
  Meaning of category for journey template task type property.
• Code: string
  Code of the journey template task type property.
• DisabledForLineManagerFlag: boolean
  Indicates if the journey template task type property is disabled for line manager. Default value depends on the task type.
• DisabledForOthersFlag: boolean
  Indicates if the journey template task type property is disabled for other users. Default value depends on the task type.
• DisabledForOwnerFlag: boolean
  Indicates if the journey template task type property is disabled for owner. Default value depends on the task type.
• DisabledForPerformerFlag: boolean
  Indicates if the journey template task type property is disabled for performer. Default value depends on the task type.
• Level: string
  Property level for the journey template task type.
• LineManagerDefaultValue: string
  Default value of the journey template task type property for line manager.
• LineManagerLookupType: string
  Journey template task type property type for line manager.
• LineManagerValue: string
  Value of the journey template task type property for line manager.
• Name: string
  Name of the journey template task type property.
• OthersDefaultValue: string
  Default value of the journey template task type property for other user.
• OthersLookupType: string
  Journey template task type property type for other user.
• OthersValue: string
  Value of the journey template task type property for other user.
• OverriddenFlag: boolean
  Indicates if the journey template task type property is overridden. Default value depends on the task type.
• OwnerDefaultValue: string
  Default value of the journey template task type property for owner.
• OwnerLookupType: string
  Journey template task type property type for owner.
• OwnerValue: string
  Value of the journey template task type property for owner.
• PerformerDefaultValue: string
  Default value of the journey template task type property for performer.
• PerformerLookupType: string
  Journey template task type property type for performer.
• PerformerValue: string
  Value of the journey template task type property for performer.
• Sequence: integer
  Sequence of the journey template task type property.

{
    "type":"object",
    "properties":{
        "Category":{
            "type":"string",
            "description":"Category of the journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of category for journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Code":{
            "type":"string",
            "description":"Code of the journey template task type property.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForLineManagerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for line manager. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOthersFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for other users. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for owner. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForPerformerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for performer. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Level":{
            "type":"string",
            "description":"Property level for the journey template task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task type property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerValue":{
            "type":"string",
            "description":"Value of the journey template task type property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersLookupType":{
            "type":"string",
            "description":"Journey template task type property type for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersValue":{
            "type":"string",
            "description":"Value of the journey template task type property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverriddenFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is overridden. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerLookupType":{
            "type":"string",
            "description":"Journey template task type property type for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Value of the journey template task type property for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerLookupType":{
            "type":"string",
            "description":"Journey template task type property type for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerValue":{
            "type":"string",
            "description":"Value of the journey template task type property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

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 : journeys-taskTypes-item-response

Type: object

Show Source

• Code: string
  Maximum Length: 61

  Code of the journey template task type property.
• JourneyId: integer
  Identifier of the journey template task type property.
• links: array Links
  Title: Links

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

  Maximum Length: 161

  Name of the journey template task type property.
• properties: array Properties
  Title: Properties

  The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.
• SubType: string
  Read Only: true

  Maximum Length: 30

  Subtype of the journey template task type property.
• SubTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Subtype meaning of the journey template task type property.
• Type: string
  Read Only: true

  Maximum Length: 30

  Type of the journey template task type property.
• TypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Type meaning of the journey template task type property.

{
    "type":"object",
    "properties":{
        "Code":{
            "maxLength":61,
            "type":"string",
            "description":"Code of the journey template task type property.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "JourneyId":{
            "type":"integer",
            "description":"Identifier of the journey template task type property.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":161,
            "type":"string",
            "description":"Name of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubType":{
            "maxLength":30,
            "type":"string",
            "description":"Subtype of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Subtype meaning of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "maxLength":30,
            "type":"string",
            "description":"Type of the journey template task type property.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Type meaning of the journey template task type property.",
            "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"
            }
        },
        "properties":{
            "title":"Properties",
            "type":"array",
            "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
            "items":{
                "$ref":"#/components/schemas/journeys-taskTypes-properties-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 : Properties

Type: array

Title: Properties

The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.

Show Source

• Array of: object journeys-taskTypes-properties-item-response

{
    "title":"Properties",
    "type":"array",
    "description":"The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.",
    "items":{
        "$ref":"#/components/schemas/journeys-taskTypes-properties-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 : journeys-taskTypes-properties-item-response

Type: object

Show Source

• Category: string
  Category of the journey template task type property.
• CategoryMeaning: string
  Meaning of category for journey template task type property.
• Code: string
  Code of the journey template task type property.
• DisabledForLineManagerFlag: boolean
  Indicates if the journey template task type property is disabled for line manager. Default value depends on the task type.
• DisabledForOthersFlag: boolean
  Indicates if the journey template task type property is disabled for other users. Default value depends on the task type.
• DisabledForOwnerFlag: boolean
  Indicates if the journey template task type property is disabled for owner. Default value depends on the task type.
• DisabledForPerformerFlag: boolean
  Indicates if the journey template task type property is disabled for performer. Default value depends on the task type.
• Level: string
  Property level for the journey template task type.
• LineManagerDefaultValue: string
  Default value of the journey template task type property for line manager.
• LineManagerLookupType: string
  Journey template task type property type for line manager.
• LineManagerValue: string
  Value of the journey template task type property for line manager.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the journey template task type property.
• OthersDefaultValue: string
  Default value of the journey template task type property for other user.
• OthersLookupType: string
  Journey template task type property type for other user.
• OthersValue: string
  Value of the journey template task type property for other user.
• OverriddenFlag: boolean
  Indicates if the journey template task type property is overridden. Default value depends on the task type.
• OwnerDefaultValue: string
  Default value of the journey template task type property for owner.
• OwnerLookupType: string
  Journey template task type property type for owner.
• OwnerValue: string
  Value of the journey template task type property for owner.
• PerformerDefaultValue: string
  Default value of the journey template task type property for performer.
• PerformerLookupType: string
  Journey template task type property type for performer.
• PerformerValue: string
  Value of the journey template task type property for performer.
• Sequence: integer
  Sequence of the journey template task type property.

{
    "type":"object",
    "properties":{
        "Category":{
            "type":"string",
            "description":"Category of the journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryMeaning":{
            "type":"string",
            "description":"Meaning of category for journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Code":{
            "type":"string",
            "description":"Code of the journey template task type property.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DisabledForLineManagerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for line manager. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOthersFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for other users. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForOwnerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for owner. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DisabledForPerformerFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is disabled for performer. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Level":{
            "type":"string",
            "description":"Property level for the journey template task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerLookupType":{
            "type":"string",
            "description":"Journey template task type property type for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineManagerValue":{
            "type":"string",
            "description":"Value of the journey template task type property for line manager.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Name":{
            "type":"string",
            "description":"Name of the journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersLookupType":{
            "type":"string",
            "description":"Journey template task type property type for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OthersValue":{
            "type":"string",
            "description":"Value of the journey template task type property for other user.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OverriddenFlag":{
            "type":"boolean",
            "description":"Indicates if the journey template task type property is overridden. Default value depends on the task type.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerLookupType":{
            "type":"string",
            "description":"Journey template task type property type for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerValue":{
            "type":"string",
            "description":"Value of the journey template task type property for owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerDefaultValue":{
            "type":"string",
            "description":"Default value of the journey template task type property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerLookupType":{
            "type":"string",
            "description":"Journey template task type property type for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "PerformerValue":{
            "type":"string",
            "description":"Value of the journey template task type property for performer.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Sequence of the journey template task type property.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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

properties

Operation: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties

Parameters:

• Code: $request.path.Code
• JourneyId: $request.path.JourneyId

The properties resource is the child of the taskTypes resource. It includes all the journey task type properties associated with the parent journey template.

Back to Top