ID Variables

Different forms of identifier variables are used with the different API functions and components. This section provides a summary of some of the key <id> variables.

objectId

An objectId is the generic term for any identifier generated when using https POST to create objects. However, not all identifiers use this generic form. Campaigns use a publicId that has special characteristics described below.

Throughout this document, you will see references to different forms of objectIds (such as callbackFeedId or contactId) that are used to distinguish the different objects being addressed. Unless noted below, consider all <id>s found in this document as objectIds.

The DELETE, GET, and PUT operations are performed using the relevant id in the REST URL. For example:

  • Use this URL to view results for a specified filter: https://<ServerIP>:<Port>/ccp-webapp/ccp/filter/<id>/results

  • Use this URL to delete a feed: https://<ServerIP>:<Port>/ccp-webapp/ccp/feed/<id>

    .

  • Use this URL to retrieve data for a single callback contact: https://<ServerIP>:<Port>/ccp/rest/callback/contact/<id>

    .

Use the list (GET) function to determine object identifiers.

publicId

Using https POST to create a campaign object generates a publicId based on the campaign name.

Note
The publicId is not editable after it is created and does not change if you change the name of the campaign.

You can generate your own publicId rather than have Customer Collaboration Platform generate one based on the campaign name. The publicId must conform to RFC 3986 for URL syntax. Spaces, slashes, and backslashes are not allowed in the publicId, and it cannot be blank. When Customer Collaboration Platform creates a publicId from the provided campaign name element, the string is formatted according to RFC 3986: spaces are replaced with underscores and slashes or backslashes are replaced with hyphens.

If the encoded name results in a collision with another object of the same type, integers starting at 1 are appended to the encoded name until a non-colliding ID is found. If the user changes the name of the campaign later, the publicId will not change.

DELETE, GET, and PUT operations for a campaign are performed using the <publicId> in the REST URL. For example:

  • Use this URL to get the count of results for a specified campaign: https://<ServerIP>:<Port>/ccp-webapp/ccp/campaign/<publicId>/count)

    .

  • Use this URL to update the configuration of a given campaign: https://<ServerIP>:<Port>/ccp-webapp/ccp/campaign/<publicId>

    .

Use the list (GET) function with summary=false to see the publicId for a campaign.