Jump to: navigation, search

Profile Extension

Prerequisites: You need to enable profiles in UCS.
Purpose: Describes an extension.


Each extension fulfills the contract of an Extension Schema that your application created in anterior operations. Your application can create schemas for the following extensions:

Once the extension schema is defined, your application can create and add extension records when dealing with standard profile, services, states, and task operations. For instance, if you start a task, you can specify extension records in your operation body as shown in the example section.

Profile Extension

Profile Extension
Field Type Mandatory Description
customer_id string yes if not nested in a profile The unique ID of the given customer.

Important.png This field is mandatory if the extension is not nested inside a Customer Profile.

name string yes The unique, case-insensitive name of the extension.
  • Starts with a letter to which you can append letters, numbers, or underscores.
  • Restricted to a maximum of 26 characters. (Maximum RDBMS shared limit on index creation.)
<attribute n>
  • string
  • integer
  • long
  • double
  • date
  • datetime
  • currency
  • boolean
yes Individual attributes, defined in the Extension Schema.
<attribute n> corresponds to the attribute name defined in the schema.

<references />

This page was last edited on July 17, 2020, at 15:47.
Comments or questions about this documentation? Contact us for support!