Jump to

• Request
• Response

Create a campaign external workspace

post

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/externalWorkspaces

Request

Path Parameters

• CampaignId(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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CampaignId(required): integer (int64)
  Unique identifier for the campaign associated with the external workspace.
• CampExternalWorkspaceId: integer (int64)
  Unique identifier for the external workspace associated with the campaign.
• CampTeamExternalMsgSenderId(required): integer (int64)
  Unique identifier for the external message sender in the campaign team.
• channels: array Campaign External Channels
  Title: Campaign External Channels

  The channels resource provides access to external communication channels for campaigns.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the external workspace object. This value helps in tracking changes to the workspace.
• TeamId(required): string
  Maximum Length: 64

  Unique identifier for the team associated with the external workspace.
• TeamName: string
  Maximum Length: 128

  Name of the team associated with the external workspace.

{
    "required":[
        "CampTeamExternalMsgSenderId",
        "CampaignId",
        "TeamId"
    ],
    "type":"object",
    "properties":{
        "CampExternalWorkspaceId":{
            "type":"integer",
            "description":"Unique identifier for the external workspace associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampTeamExternalMsgSenderId":{
            "type":"integer",
            "description":"Unique identifier for the external message sender in the campaign team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignId":{
            "type":"integer",
            "description":"Unique identifier for the campaign associated with the external workspace.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the external workspace object. This value helps in tracking changes to the workspace.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "TeamId":{
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier for the team associated with the external workspace.",
            "nullable":false
        },
        "TeamName":{
            "maxLength":128,
            "type":"string",
            "description":"Name of the team associated with the external workspace.",
            "nullable":true
        },
        "channels":{
            "title":"Campaign External Channels",
            "type":"array",
            "description":"The channels resource provides access to external communication channels for campaigns.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-externalWorkspaces-channels-item-post-request"
            }
        }
    }
}

Nested Schema : Campaign External Channels

Type: array

Title: Campaign External Channels

The channels resource provides access to external communication channels for campaigns.

Show Source

• Array of: object schema

{
    "title":"Campaign External Channels",
    "type":"array",
    "description":"The channels resource provides access to external communication channels for campaigns.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-externalWorkspaces-channels-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CampExternalChannelId: integer (int64)
  Unique identifier for the external channel used in the campaign.
• CampExternalWorkspaceId: integer (int64)
  Unique identifier for the external workspace channel associated with the campaign.
• ChannelId: string
  Maximum Length: 128

  Unique identifier for the external channel used in the campaign.
• ChannelName: string
  Maximum Length: 128

  Name of the external channel used in the campaign communication.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the campaign external channel object. This value helps in tracking changes to the object.

{
    "type":"object",
    "properties":{
        "CampExternalChannelId":{
            "type":"integer",
            "description":"Unique identifier for the external channel used in the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampExternalWorkspaceId":{
            "type":"integer",
            "description":"Unique identifier for the external workspace channel associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChannelId":{
            "maxLength":128,
            "type":"string",
            "description":"Unique identifier for the external channel used in the campaign.",
            "nullable":false
        },
        "ChannelName":{
            "maxLength":128,
            "type":"string",
            "description":"Name of the external channel used in the campaign communication.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the campaign external channel object. This value helps in tracking changes to the object.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

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 : communicateUICampaignDetails-externalWorkspaces-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Unique identifier for the campaign associated with the external workspace.
• CampExternalWorkspaceId: integer (int64)
  Unique identifier for the external workspace associated with the campaign.
• CampTeamExternalMsgSenderId: integer (int64)
  Unique identifier for the external message sender in the campaign team.
• channels: array Campaign External Channels
  Title: Campaign External Channels

  The channels resource provides access to external communication channels for campaigns.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the external workspace.
• CreationDate: string (date-time)
  Read Only: true

  Date when the external workspace was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date and time of the external workspace.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the external workspace in the campaign.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last update login identifier for the external workspace.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the external workspace object. This value helps in tracking changes to the workspace.
• TeamId: string
  Maximum Length: 64

  Unique identifier for the team associated with the external workspace.
• TeamName: string
  Maximum Length: 128

  Name of the team associated with the external workspace.

{
    "type":"object",
    "properties":{
        "CampExternalWorkspaceId":{
            "type":"integer",
            "description":"Unique identifier for the external workspace associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampTeamExternalMsgSenderId":{
            "type":"integer",
            "description":"Unique identifier for the external message sender in the campaign team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Unique identifier for the campaign associated with the external workspace.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the external workspace.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the external workspace was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date and time of the external workspace.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login identifier for the external workspace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the external workspace in the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the external workspace object. This value helps in tracking changes to the workspace.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TeamId":{
            "maxLength":64,
            "type":"string",
            "description":"Unique identifier for the team associated with the external workspace.",
            "nullable":false,
            "x-queryable":true
        },
        "TeamName":{
            "maxLength":128,
            "type":"string",
            "description":"Name of the team associated with the external workspace.",
            "nullable":true,
            "x-queryable":true
        },
        "channels":{
            "title":"Campaign External Channels",
            "type":"array",
            "description":"The channels resource provides access to external communication channels for campaigns.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-externalWorkspaces-channels-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Campaign External Channels

Type: array

Title: Campaign External Channels

The channels resource provides access to external communication channels for campaigns.

Show Source

• Array of: object communicateUICampaignDetails-externalWorkspaces-channels-item-response

{
    "title":"Campaign External Channels",
    "type":"array",
    "description":"The channels resource provides access to external communication channels for campaigns.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-externalWorkspaces-channels-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 : communicateUICampaignDetails-externalWorkspaces-channels-item-response

Type: object

Show Source

• CampExternalChannelId: integer (int64)
  Unique identifier for the external channel used in the campaign.
• CampExternalWorkspaceId: integer (int64)
  Unique identifier for the external workspace channel associated with the campaign.
• ChannelId: string
  Maximum Length: 128

  Unique identifier for the external channel used in the campaign.
• ChannelName: string
  Maximum Length: 128

  Name of the external channel used in the campaign communication.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates who created the external channel for the campaign. This field is read-only and automatically populated by the application.
• CreationDate: string (date-time)
  Read Only: true

  Date when the external channel was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last updated date and time of the external channel for the campaign.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last updated by information for the campaign external channel.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last updated login identifier for the external channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the campaign external channel object. This value helps in tracking changes to the object.

{
    "type":"object",
    "properties":{
        "CampExternalChannelId":{
            "type":"integer",
            "description":"Unique identifier for the external channel used in the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampExternalWorkspaceId":{
            "type":"integer",
            "description":"Unique identifier for the external workspace channel associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelId":{
            "maxLength":128,
            "type":"string",
            "description":"Unique identifier for the external channel used in the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelName":{
            "maxLength":128,
            "type":"string",
            "description":"Name of the external channel used in the campaign communication.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created the external channel for the campaign. This field is read-only and automatically populated by the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the external channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last updated date and time of the external channel for the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last updated login identifier for the external channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last updated by information for the campaign external channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the campaign external channel object. This value helps in tracking changes to the object.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "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."
        }
    }
}

Links

channels

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/externalWorkspaces/{CampExternalWorkspaceId}/child/channels

Parameters:

• CampExternalWorkspaceId: $request.path.CampExternalWorkspaceId
• CampaignId: $request.path.CampaignId

The channels resource provides access to external communication channels for campaigns.

Back to Top