Update an event type
patch
/crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The description of the subscription event type. -
eventTypeAttributes: array
Subscription Usage Event Type Attributes
Title:
Subscription Usage Event Type Attributes
The event type attributes resource is used to view, create, update, and delete an event type attribute. -
eventTypeCharges: array
Subscription Usage Event Type Charges
Title:
Subscription Usage Event Type Charges
The event type charges resource is used to view, create, update, and delete an event type charge. -
Name: string
Title:
Name
Maximum Length:120
The name of the subscription event type. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription event type.
-
Status: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of the subscription event type.
Nested Schema : Subscription Usage Event Type Attributes
Type:
array
Title:
Subscription Usage Event Type Attributes
The event type attributes resource is used to view, create, update, and delete an event type attribute.
Show Source
Nested Schema : Subscription Usage Event Type Charges
Type:
array
Title:
Subscription Usage Event Type Charges
The event type charges resource is used to view, create, update, and delete an event type charge.
Show Source
Nested 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. -
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.
Nested Schema : schema
Type:
Show Source
object
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription event type charge. -
ChargeDefinitionId: integer
(int64)
Title:
Charge Name
The charge definition identifier of the subscription event type charge. -
EventTypeId: integer
(int64)
The event type identifier of the subscription event type charge.
-
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription event type charge.
-
QuantityAttributeId: integer
(int64)
Title:
Quantity
The quantity attribute identifier of the subscription event type charge. -
QuantityAttributeName: string
Title:
Quantity
Maximum Length:240
The quantity attribute name of the subscription event type charge. -
ReportedQuantityAttributeId: integer
(int64)
Title:
Reported Quantity
The reported quantity attribute identifier of the subscription event type charge. -
ReportedQuantityAttributeName: string
Title:
Reported Quantity
Maximum Length:240
The reported quantity attribute name of the subscription event type charge. -
UnitOfMeasureAttributeId: integer
(int64)
Title:
UOM
The unit of measure attribute identifier of the subscription event type charge. -
UnitOfMeasureAttributeName: string
Title:
UOM
Maximum Length:240
The unit of measure attribute name of the subscription event type charge.
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-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription event type. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription event type was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the subscription event type. -
EventType: string
Title:
Number
Maximum Length:30
The unique number of the subscription event type. -
eventTypeAttributes: array
Subscription Usage Event Type Attributes
Title:
Subscription Usage Event Type Attributes
The event type attributes resource is used to view, create, update, and delete an event type attribute. -
eventTypeCharges: array
Subscription Usage Event Type Charges
Title:
Subscription Usage Event Type Charges
The event type charges resource is used to view, create, update, and delete an event type charge. -
EventTypeId: integer
(int64)
The unique identifier of the subscription event type.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription event type was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the subscription event type. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription event type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:120
The name of the subscription event type. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription event type.
-
Status: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of the subscription event type.
Nested Schema : Subscription Usage Event Type Attributes
Type:
array
Title:
Subscription Usage Event Type Attributes
The event type attributes resource is used to view, create, update, and delete an event type attribute.
Show Source
Nested Schema : Subscription Usage Event Type Charges
Type:
array
Title:
Subscription Usage Event Type Charges
The event type charges resource is used to view, create, update, and delete an event type charge.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.
Nested Schema : subscriptionUsageEventTypes-eventTypeCharges-item-response
Type:
Show Source
object
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription event type charge. -
ChargeDefinitionId: integer
(int64)
Title:
Charge Name
The charge definition identifier of the subscription event type charge. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription event type charge. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription event type charge was created. -
EventTypeChargeId: integer
(int64)
The unique identifier of the subscription event type charge.
-
EventTypeChargeName: string
Title:
Number
Maximum Length:240
The unique name of the subscription event type charge. -
EventTypeId: integer
(int64)
The event type identifier of the subscription event type charge.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription event type charge was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription event type charge. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription event type charge. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription event type charge.
-
QuantityAttributeId: integer
(int64)
Title:
Quantity
The quantity attribute identifier of the subscription event type charge. -
QuantityAttributeName: string
Title:
Quantity
Maximum Length:240
The quantity attribute name of the subscription event type charge. -
ReportedQuantityAttributeId: integer
(int64)
Title:
Reported Quantity
The reported quantity attribute identifier of the subscription event type charge. -
ReportedQuantityAttributeName: string
Title:
Reported Quantity
Maximum Length:240
The reported quantity attribute name of the subscription event type charge. -
UnitOfMeasureAttributeId: integer
(int64)
Title:
UOM
The unit of measure attribute identifier of the subscription event type charge. -
UnitOfMeasureAttributeName: string
Title:
UOM
Maximum Length:240
The unit of measure attribute name of the subscription event type charge.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- activate
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/action/activateParameters:
- EventType:
$request.path.EventType
This method is used to activate an event type. - EventType:
- deActivate
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/action/deActivateParameters:
- EventType:
$request.path.EventType
This method is used to deactivate an event type. - EventType:
- eventTypeAttributes
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeAttributesParameters:
- EventType:
$request.path.EventType
The event type attributes resource is used to view, create, update, and delete an event type attribute. - EventType:
- eventTypeCharges
-
Operation: /crmRestApi/resources/11.13.18.05/subscriptionUsageEventTypes/{EventType}/child/eventTypeChargesParameters:
- EventType:
$request.path.EventType
The event type charges resource is used to view, create, update, and delete an event type charge. - EventType: