Jump to

• Request
• Response

Create a contact in a journey template

post

/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts

Request

Path Parameters

• 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

• ContactPersonId: integer
  Internal identifier of the journey contact.
• ContactUser: string
  Maximum Length: 64

  User name of the journey contact.
• CustomContact: string
  Maximum Length: 400

  Custom contact details
• ResponsibilityType: string
  Maximum Length: 30

  Responsibility type of the journey contact.
• Title: string
  Maximum Length: 30

  Title of the contact. For example, Onboarding Sponsor.
• Type: string
  Maximum Length: 30

  Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. Example, Line Manager, AOR.

{
    "type":"object",
    "properties":{
        "ContactPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContactUser":{
            "maxLength":64,
            "type":"string",
            "description":"User name of the journey contact.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomContact":{
            "maxLength":400,
            "type":"string",
            "description":"Custom contact details",
            "nullable":true,
            "x-queryable":false
        },
        "ResponsibilityType":{
            "maxLength":30,
            "type":"string",
            "description":"Responsibility type of the journey contact.",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "maxLength":30,
            "type":"string",
            "description":"Title of the contact. For example, Onboarding Sponsor.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Type":{
            "maxLength":30,
            "type":"string",
            "description":"Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. Example, Line Manager, AOR.",
            "nullable":false,
            "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-contacts-item-response

Type: object

Show Source

• ContactPersonId: integer
  Internal identifier of the journey contact.
• ContactUser: string
  Maximum Length: 64

  User name of the journey contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date the contact was created.
• CustomContact: string
  Maximum Length: 400

  Custom contact details
• JourneyContactId: integer (int64)
  Read Only: true

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

  Date the contact was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• ResponsibilityType: string
  Maximum Length: 30

  Responsibility type of the journey contact.
• ResponsibilityTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Responsibility type meaning of the journey contact.
• Title: string
  Maximum Length: 30

  Title of the contact. For example, Onboarding Sponsor.
• TitleMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the contact type.
• Type: string
  Maximum Length: 30

  Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. Example, Line Manager, AOR.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the contact type.

{
    "type":"object",
    "properties":{
        "ContactPersonId":{
            "type":"integer",
            "description":"Internal identifier of the journey contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContactUser":{
            "maxLength":64,
            "type":"string",
            "description":"User name of the journey contact.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomContact":{
            "maxLength":400,
            "type":"string",
            "description":"Custom contact details",
            "nullable":true,
            "x-queryable":false
        },
        "JourneyContactId":{
            "type":"integer",
            "description":"Unique identifier of the journey contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResponsibilityType":{
            "maxLength":30,
            "type":"string",
            "description":"Responsibility type of the journey contact.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponsibilityTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Responsibility type meaning of the journey contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Title":{
            "maxLength":30,
            "type":"string",
            "description":"Title of the contact. For example, Onboarding Sponsor.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TitleMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the contact type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Type":{
            "maxLength":30,
            "type":"string",
            "description":"Type of contact. Valid values are from the ORA_PER_ONB_CONTACT_TYPE lookup. Example, Line Manager, AOR.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the contact type.",
            "nullable":false,
            "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 : 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."
        }
    }
}

Back to Top