Jump to

• Request
• Response

Get a communication

get

/hcmRestApi/resources/11.13.18.05/communicateUIMyCommunications/{CommunicationId}

Request

Path Parameters

• CommunicationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

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

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : communicateUIMyCommunications-item-response

Type: object

Show Source

• BgImgURL: string
  Read Only: true

  Maximum Length: 1000

  Background image URL of a communication.
• CampaignId: integer
  Read Only: true

  Unique identifier for a campaign.
• CategoryCodes: string
  Read Only: true

  Maximum Length: 255

  List of category codes associated with a communication.
• CategoryNames: string
  Read Only: true

  Maximum Length: 255

  List of category names associated with a communication.
• CommunicationId: integer (int64)
  Read Only: true

  Unique identifier for a communication.
• CommunicationStatus: string
  Read Only: true

  Maximum Length: 30

  Indicates whether the communication was opened or not.
• CommunicationType: string
  Read Only: true

  Maximum Length: 5

  Type of the communication such as email, post or event.
• Description: string
  Read Only: true

  Description of a communication.
• EndDate: string (date)
  Read Only: true

  End date of a communication.
• EventFormat: string
  Read Only: true

  Maximum Length: 255

  Indicates whether the event is in-person or virtual.
• links: array Links
  Title: Links

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

  Unique identifier of a person.
• PreviewObjectId: string
  Read Only: true

  Maximum Length: 255

  Internal identifier for an email communication.
• PrimaryLabel: string
  Read Only: true

  Maximum Length: 64

  Label for the primary action link.
• PrimaryLinkText: string
  Read Only: true

  Maximum Length: 4000

  Link associated with the primary action.
• PrimaryLinkTypeCode: string
  Read Only: true

  Maximum Length: 32

  Indicates whether the primary link is custom or predefined.
• PurposeCode: string
  Read Only: true

  Maximum Length: 30

  Purpose of a campaign.
• RegisteredCount: integer
  Read Only: true

  Number of registrations for an event.
• ResponseStatus: string
  Read Only: true

  Maximum Length: 7

  Indicates whether the user responded or not to the specified email.
• ResponseURLId: integer
  Read Only: true

  Internal identifier for the response URL on an email.
• SecondaryLabel: string
  Read Only: true

  Maximum Length: 64

  Label for the secondary action link.
• SecondaryLinkText: string
  Read Only: true

  Maximum Length: 4000

  Link associated with the secondary action.
• SecondaryLinkTypeCode: string
  Read Only: true

  Maximum Length: 32

  Indicates whether the secondary link is custom or predefined.
• SenderEmail: string
  Read Only: true

  Maximum Length: 240

  Email address of the sender.
• SenderId: integer
  Read Only: true

  Unique identifier of the sender.
• SenderName: string
  Read Only: true

  Maximum Length: 240

  Name of the sender.
• SentDate: string (date)
  Read Only: true

  Sent date of a communication.
• StartDate: string (date)
  Read Only: true

  Start date of a communication.
• Subject: string
  Read Only: true

  Maximum Length: 2000

  Subject of a communication.
• SubjectCode: string
  Read Only: true

  Maximum Length: 240

  Indicates whether it's a communicate post or team post.
• SubjectSearchText: string
  Read Only: true

  Maximum Length: 2500

  Searchable text in the subject of a communication.
• TimeZoneCode: string
  Read Only: true

  Maximum Length: 255

  Event time zone.
• ViewTrackingURL: string
  Read Only: true

  Maximum Length: 4000

  URL to track communication views.

{
    "type":"object",
    "properties":{
        "BgImgURL":{
            "maxLength":1000,
            "type":"string",
            "description":"Background image URL of a communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Unique identifier for a campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCodes":{
            "maxLength":255,
            "type":"string",
            "description":"List of category codes associated with a communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryNames":{
            "maxLength":255,
            "type":"string",
            "description":"List of category names associated with a communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationId":{
            "type":"integer",
            "description":"Unique identifier for a communication.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommunicationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the communication was opened or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommunicationType":{
            "maxLength":5,
            "type":"string",
            "description":"Type of the communication such as email, post or event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of a communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"End date of a communication.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventFormat":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the event is in-person or virtual.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of a person.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviewObjectId":{
            "maxLength":255,
            "type":"string",
            "description":"Internal identifier for an email communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLabel":{
            "maxLength":64,
            "type":"string",
            "description":"Label for the primary action link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLinkText":{
            "maxLength":4000,
            "type":"string",
            "description":"Link associated with the primary action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLinkTypeCode":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates whether the primary link is custom or predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Purpose of a campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RegisteredCount":{
            "type":"integer",
            "description":"Number of registrations for an event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseStatus":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates whether the user responded or not to the specified email.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseURLId":{
            "type":"integer",
            "description":"Internal identifier for the response URL on an email.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryLabel":{
            "maxLength":64,
            "type":"string",
            "description":"Label for the secondary action link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryLinkText":{
            "maxLength":4000,
            "type":"string",
            "description":"Link associated with the secondary action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryLinkTypeCode":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates whether the secondary link is custom or predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderEmail":{
            "maxLength":240,
            "type":"string",
            "description":"Email address of the sender.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderId":{
            "type":"integer",
            "description":"Unique identifier of the sender.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the sender.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SentDate":{
            "type":"string",
            "description":"Sent date of a communication.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of a communication.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":2000,
            "type":"string",
            "description":"Subject of a communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectCode":{
            "maxLength":240,
            "type":"string",
            "description":"Indicates whether it's a communicate post or team post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectSearchText":{
            "maxLength":2500,
            "type":"string",
            "description":"Searchable text in the subject of a communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TimeZoneCode":{
            "maxLength":255,
            "type":"string",
            "description":"Event time zone.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewTrackingURL":{
            "maxLength":4000,
            "type":"string",
            "description":"URL to track communication views.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top