Get a subscription account role
get
/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountRoles/{SubscrAccRoleNumber}
Request
Path Parameters
-
SubscrAccRoleNumber(required): string
The alternate unique identifier of the subscription account.
-
SubscrAccountNumber(required): string
The alternate unique identifier of the subscription account.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-subscriptionAccountRoles-item-response
Type:
Show Source
object
-
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The application composer extensibility schema field. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The application composer extensibility schema field. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The application composer extensibility schema field. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the subscription account role has been deleted. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The primary email address of the party. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The party who got assigned with the role. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the subscription account. -
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique identifier of the party. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
The type of the party associated with the subscription account. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the party. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the party. -
RoleName: string
Title:
Role
Maximum Length:30
The role of the consumer for the subscription account. -
SubscrAccMgmtRoleId: integer
(int64)
Title:
Subscription Account Roles ID
Read Only:true
The unique identifier for storing subscription account role record. -
SubscrAccountNumber: string
Title:
Subscription Account Number
Maximum Length:30
The alternate unique identifier of the subscription account. -
SubscrAccRoleNumber: string
Title:
Subscription Account Role Number
Maximum Length:30
The alternate unique identifier of the subscription account. -
SubscriptionAccountId: integer
(int64)
Title:
Subscription Account ID
The subscription account associated to the subscription account role record. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the subscription account role has been 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
- RoleNameListVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_ROLE_TYPE
The list of values indicating the subscription account role type.
The following properties are defined on the LOV link relation:- Source Attribute: RoleName; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: