Jump to

• Request
• Response

Get all campaign assets

patch

/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}

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=
• CampaignCode(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=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetName: string
  Maximum Length: 240

  Name assigned to each asset.
• AssetStatusCode: string
  Maximum Length: 30

  Code assigned to each status of asset.
• AssetTypeCode: string
  Maximum Length: 30

  Code assigned to each type of asset.
• AudienceDerivedFlag: boolean
  Maximum Length: 1

  Indicates that the campaign is for derived audience.
• CampaignAssetChannels: array Campaign Asset Channels
  Title: Campaign Asset Channels

  The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
• campaignAssetSegments: array Campaign Asset Segments
  Title: Campaign Asset Segments

  The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
• DisplayRank: integer
  Rank of the campaign asset.
• MessageDesignId: integer (int64)
  ID assigned to each message design.
• ParentAssetId: integer (int64)
  ID assigned to the parent asset.
• ScheduledDate: string (date-time)
  Date when the campaign is scheduled.
• SortOrderDate: string (date-time)
  Date of sorting the order.

{
    "type":"object",
    "properties":{
        "campaignAssetSegments":{
            "title":"Campaign Asset Segments",
            "type":"array",
            "description":"The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.",
            "items":{
                "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-patch-request"
            }
        },
        "AssetStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each status of asset.",
            "nullable":false
        },
        "AudienceDerivedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the campaign is for derived audience.",
            "nullable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"ID assigned to each message design.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CampaignAssetChannels":{
            "title":"Campaign Asset Channels",
            "type":"array",
            "description":"The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.",
            "items":{
                "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-patch-request"
            }
        },
        "ParentAssetId":{
            "type":"integer",
            "description":"ID assigned to the parent asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DisplayRank":{
            "type":"integer",
            "description":"Rank of the campaign asset.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssetStatusCode",
                    "ParentAssetId"
                ]
            }
        },
        "AssetTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each type of asset.",
            "nullable":false
        },
        "ScheduledDate":{
            "type":"string",
            "description":"Date when the campaign is scheduled.",
            "format":"date-time",
            "nullable":true
        },
        "SortOrderDate":{
            "type":"string",
            "description":"Date of sorting the order.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CreationDate",
                    "AssetStatusCode",
                    "ScheduledDate"
                ]
            }
        },
        "AssetName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name assigned to each asset.",
            "nullable":false
        }
    }
}

Nested Schema : Campaign Asset Channels

Type: array

Title: Campaign Asset Channels

The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.

Show Source

• Array of: object recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-patch-request

{
    "title":"Campaign Asset Channels",
    "type":"array",
    "description":"The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.",
    "items":{
        "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-patch-request"
    }
}

Nested Schema : Campaign Asset Segments

Type: array

Title: Campaign Asset Segments

The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.

Show Source

• Array of: object recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-patch-request

{
    "title":"Campaign Asset Segments",
    "type":"array",
    "description":"The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.",
    "items":{
        "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-patch-request"
    }
}

Nested Schema : recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : recruitingCampaignDetails-campaignAssets-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Read Only: true

  ID assigned to each asset for campaign asset.
• AssetName: string
  Maximum Length: 240

  Name assigned to each asset.
• AssetStatusCode: string
  Maximum Length: 30

  Code assigned to each status of asset.
• AssetTypeCode: string
  Maximum Length: 30

  Code assigned to each type of asset.
• AudienceDerivedFlag: boolean
  Maximum Length: 1

  Indicates that the campaign is for derived audience.
• CampaignAssetChannels: array Campaign Asset Channels
  Title: Campaign Asset Channels

  The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
• campaignAssetSegments: array Campaign Asset Segments
  Title: Campaign Asset Segments

  The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
• DisplayRank: integer
  Rank of the campaign asset.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageDesignId: integer (int64)
  ID assigned to each message design.
• ParentAssetId: integer (int64)
  ID assigned to the parent asset.
• ScheduledDate: string (date-time)
  Date when the campaign is scheduled.
• SortOrderDate: string (date-time)
  Date of sorting the order.

{
    "type":"object",
    "properties":{
        "AudienceDerivedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the campaign is for derived audience.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduledDate":{
            "type":"string",
            "description":"Date when the campaign is scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SortOrderDate":{
            "type":"string",
            "description":"Date of sorting the order.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CreationDate",
                    "AssetStatusCode",
                    "ScheduledDate"
                ]
            },
            "x-queryable":true
        },
        "AssetName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name assigned to each asset.",
            "nullable":false,
            "x-queryable":true
        },
        "campaignAssetSegments":{
            "title":"Campaign Asset Segments",
            "type":"array",
            "description":"The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.",
            "items":{
                "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-response"
            }
        },
        "AssetStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each status of asset.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageDesignId":{
            "type":"integer",
            "description":"ID assigned to each message design.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CampaignAssetChannels":{
            "title":"Campaign Asset Channels",
            "type":"array",
            "description":"The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.",
            "items":{
                "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-response"
            }
        },
        "ParentAssetId":{
            "type":"integer",
            "description":"ID assigned to the parent asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayRank":{
            "type":"integer",
            "description":"Rank of the campaign asset.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssetStatusCode",
                    "ParentAssetId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each type of asset.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"ID assigned to each asset for campaign asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Asset Channels

Type: array

Title: Campaign Asset Channels

The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.

Show Source

• Array of: object recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-response

{
    "title":"Campaign Asset Channels",
    "type":"array",
    "description":"The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.",
    "items":{
        "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-response"
    }
}

Nested Schema : Campaign Asset Segments

Type: array

Title: Campaign Asset Segments

The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.

Show Source

• Array of: object recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-response

{
    "title":"Campaign Asset Segments",
    "type":"array",
    "description":"The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.",
    "items":{
        "$ref":"#/components/schemas/recruitingCampaignDetails-campaignAssets-campaignAssetSegments-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 : recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Read Only: true

  ID assigned to each asset for campaign asset channel.
• ChannelId: integer
  Read Only: true

  ID assigned to each channel.
• ChannelPostURL: string
  Read Only: true

  Maximum Length: 1000

  URL of the channel where campaign is posted.
• ChannelTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code assigned to each type of channel.
• ChannelTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  Description of each channel type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ChannelTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Description of each channel type.",
            "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"
            }
        },
        "ChannelPostURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL of the channel where campaign is posted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each type of channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "type":"integer",
            "description":"ID assigned to each channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"ID assigned to each asset for campaign asset channel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Nested Schema : recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-response

Type: object

Show Source

• AssetSegmentId: integer (int64)
  Read Only: true

  ID assigned to each asset segment.
• CriteriaTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code assigned to each criteria type.
• GoalResponseId: integer (int64)
  Read Only: true

  ID assigned to each response of a goal for the campaign asset segment.
• links: array Links
  Title: Links

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

  Maximum Length: 240

  Label assigned to each response for the campaign asset segment.
• SegmentName: string
  Read Only: true

  Name of each segment.
• SegmentTypeCode: string
  Read Only: true

  Maximum Length: 30

  Code assigned to each segment type.
• SegmentTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Description of each segment type.

{
    "type":"object",
    "properties":{
        "CriteriaTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each criteria type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "type":"string",
            "description":"Name of each segment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ResponseLabel",
                    "SegmentTypeMeaning"
                ]
            },
            "x-queryable":true
        },
        "SegmentTypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Description of each segment type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code assigned to each segment type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetSegmentId":{
            "type":"integer",
            "description":"ID assigned to each asset segment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"ID assigned to each response of a goal for the campaign asset segment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResponseLabel":{
            "maxLength":"240",
            "type":"string",
            "description":"Label assigned to each response for the campaign asset segment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

CampaignAssetChannels

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels

Parameters:

• AssetId: $request.path.AssetId
• CampaignCode: $request.path.CampaignCode

The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.

campaignAssetSegments

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments

Parameters:

• AssetId: $request.path.AssetId
• CampaignCode: $request.path.CampaignCode

The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.

Back to Top