Working with REST V2 Resource Attributes
Defining a REST V2 Resource Attribute
You can define the attributes of a REST V2 resource and access the resource using any of these attributes. If you want to access a REST V2 resource using JSON API, you must define an attribute that acts as an unique identifier.
Designer uses this unique identifier to create all the JSON API compliant URL templates for the resource. You can view these URLs on the
Resource Configuration tab. If you want to add a new URL, see
Defining a REST V2 Resource
Operation.
To define a REST V2 resource attribute
1. In the Package Navigator view of Designer, double click the REST V2 resource for which you want to define the attribute.
2. On the Attribute Configuration tab, click Add.
3. In the Add Attribute dialog box, specify the following:
Field | Description |
Attribute Name | The name of the attribute. |
Attribute Type | The data type of the attribute. |
Selected Entity | The document type or REST V2 resource. You can browse and select the entity. Note:
You can only select an entity when the attribute types are Document Reference, Document Reference List, or Resource. |
Relationship Type | The relationship type between two REST V2 resources. Supported relationship types are One to One and One to Many. Note:
If you want to assign relationship between two REST V2 references, set the Attribute Type as Resource, Selected Entity as the resource with which you want to associate relationship, and the Relationship Type as either One to One or One to Many. |
4. Click OK.
5. To use the new attribute as the unique identifier for the REST V2 resource, select the check box in the Unique Identifier column and to make the REST V2 resource as JSON API compliant, set Generate JSON API URLs property as True. For more information about this property, refer to
REST V2 Resource Properties.