Jump to

• Request
• Response

Update a campaign asset external channel

patch

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/externalChannels/{CampAssetExternalChannelId}

Request

Path Parameters

• AssetId(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=
• CampAssetExternalChannelId(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=
• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetId: integer (int64)
  Unique identifier for the asset in the external channel.
• CampExternalChannelId: integer (int64)
  Unique identifier for the external channel associated with the campaign asset.
• CampExternalWorkspaceId: integer (int64)
  Unique identifier for the external workspace associated with the campaign asset.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the external channel object.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Unique identifier for the asset in the external channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampExternalChannelId":{
            "type":"integer",
            "description":"Unique identifier for the external channel associated with the campaign asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampExternalWorkspaceId":{
            "type":"integer",
            "description":"Unique identifier for the external workspace associated with the campaign asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the external channel 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-assetDetails-externalChannels-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Unique identifier for the asset in the external channel.
• CampAssetExternalChannelId: integer (int64)
  Unique identifier for the external channel for the campaign asset.
• CampExternalChannelId: integer (int64)
  Unique identifier for the external channel associated with the campaign asset.
• CampExternalWorkspaceId: integer (int64)
  Unique identifier for the external workspace associated with the campaign asset.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Date and time when the external channel asset was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the external channel asset.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login identifier used for the last update to the external channel asset.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Unique identifier for the version of the external channel object.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Unique identifier for the asset in the external channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampAssetExternalChannelId":{
            "type":"integer",
            "description":"Unique identifier for the external channel for the campaign asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampExternalChannelId":{
            "type":"integer",
            "description":"Unique identifier for the external channel associated with the campaign asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampExternalWorkspaceId":{
            "type":"integer",
            "description":"Unique identifier for the external workspace associated with the campaign asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created the external channel asset. This field is read-only and automatically populated by the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the external channel asset was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the external channel asset was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login identifier used for the last update to the external channel asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the external channel asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Unique identifier for the version of the external channel 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."
        }
    }
}

Back to Top