Create an event type attribute
post
/crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributes
Request
Path Parameters
-
EventType(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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AttributeId: integer
(int64)
The unique identifier of the subscription event type attribute.
-
AttributeName: string
Title:
Name
Maximum Length:240
The name of the attribute. -
EventAttributeType: string
Title:
Type
Maximum Length:30
The event attribute type of the subscription event type attribute. -
EventTypeAttributeId: integer
(int64)
The unique identifier of the subscription event type attribute.
-
EventTypeAttributeName: string
Title:
Number
Maximum Length:240
The unique name of the subscription event type attribute. -
EventTypeId: integer
(int64)
The event type identifier of the subscription event type attribute.
-
ObjectName: string
Title:
Object
Maximum Length:120
Default Value:SubscriptionUsageEvent
The object name of the subscription event type attribute. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription event type attribute.
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.
Root Schema : subscriptionUsageEventTypes-eventTypeAttributes-item-response
Type:
Show Source
object
-
AttributeId: integer
(int64)
The unique identifier of the subscription event type attribute.
-
AttributeName: string
Title:
Name
Maximum Length:240
The name of the attribute. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription event type attribute. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription event type attribute was created. -
EventAttributeType: string
Title:
Type
Maximum Length:30
The event attribute type of the subscription event type attribute. -
EventTypeAttributeId: integer
(int64)
The unique identifier of the subscription event type attribute.
-
EventTypeAttributeName: string
Title:
Number
Maximum Length:240
The unique name of the subscription event type attribute. -
EventTypeId: integer
(int64)
The event type identifier of the subscription event type attribute.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription event type attribute was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the subscription event type attribute. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription event type attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectName: string
Title:
Object
Maximum Length:120
Default Value:SubscriptionUsageEvent
The object name of the subscription event type attribute. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription event type attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.