Update a subscription account relationship
patch
/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRelationship/{SubscriptionAccountRelationshipNumber}
Request
Path Parameters
-
SubscrAccountNumber(required): string
The alternate unique identifier of the subscription account.
-
SubscriptionAccountRelationshipNumber(required): string
The alternate identifier of the subscription account relationship.
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
-
Comments: string
Title:
Comments
Maximum Length:2000
The comments for subscription account relationship. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the subscription account relationship. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The date when the record was created. -
PartyId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the party. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The alternate identifier of the record. -
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The type of the relationship.
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 : subscriptionAccounts-subscriptionAccountRelationship-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
The comments for subscription account relationship. -
ContactId: integer
Title:
Contact ID
Read Only:true
The unique identifier of the contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the subscription account relationship. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The date when the record was created. -
DeleteFlag: boolean
Read Only:
true
The rate of currency conversion for a subscription account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Indicates whether the account relationship can be deleted. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The login of the user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the party. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The alternate identifier of the record. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
The type of the party. -
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The type of the relationship. -
RelationshipTypeLookup: string
Title:
Relationship Type Lookup Code
Read Only:true
The relationship type lookup associated with the subscription account relationship. It's used to expose the Lookup code of RelationshipType field based on Party Type. -
SalesAccountId: integer
Title:
Sales Account ID
Read Only:true
The unique identifier of the sales account. -
SubscrAccountNumber: string
Title:
Subscription Account Number
Read Only:true
Maximum Length:30
The alternate identifier of the subscription account. -
SubscriptionAccountId: integer
(int64)
Title:
Subscription Account ID
The unique identifier of the subscription account. -
SubscriptionAccountRelationshipId: integer
(int64)
Title:
Subscription Account Relationship ID
Read Only:true
The unique identifier of the subscription account relationship. -
SubscriptionAccountRelationshipNumber: string
Title:
Subscription Account Relationship Number
Maximum Length:30
The alternate identifier of the subscription account relationship. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the record can be updated.
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.
Links
- OrganizationVA
-
Operation: /crmRestApi/resources/11.13.18.05/accountsThe following properties are defined on the LOV link relation:
- Source Attribute: SalesAccountId; Target Attribute: PartyId
- Display Attribute: PartyUniqueName
- PersonVA
-
Operation: /crmRestApi/resources/11.13.18.05/contactsThe following properties are defined on the LOV link relation:
- Source Attribute: ContactId; Target Attribute: PartyId
- Display Attribute: ContactName
- RelationshipTypeVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3D{RelationshipTypeLookup}
The following properties are defined on the LOV link relation:- Source Attribute: RelationshipType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: