Get a partner
get
/crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}
Request
Path Parameters
-
partnersLOVUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Partners resource and used to uniquely identify an instance of Partners. The client should not generate the hash key value. Instead, the client should query on the Partners collection resource in order to navigate to a specific instance of Partners to get the hash key.
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 : partnersLOV-item-response
Type:
Show Source
object
-
AccountDirectorId: integer
(int64)
The unique identifier of the owner resource for this partner.
-
Address: string
Title:
Address
Read Only:true
Maximum Length:255
That address of the partner. -
City: string
Title:
City
Read Only:true
Maximum Length:60
The city name of the partner address. -
CompanyNumber: string
Title:
Partner Number
Maximum Length:30
The alternate key identifier of the partner's company. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The country associated with the partner. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address of the partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Location
Maximum Length:90
The location of the address. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
The lookup code. This attribute is internal. -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
The lookup type. This attribute is internal. -
PartnerAccountId: integer
(int64)
Read Only:
true
The unique identifier of the partner account. This attribute is internal. -
partnerContactManagersLOV: array
Partner Contact Managers
Title:
Partner Contact Managers
The partner contact managers list of values resource is used to view a list of partner contacts in a managerial role. -
partnerDimensionsLOV: array
Partner Types
Title:
Partner Types
The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, or distributor. -
partnerEnrolledProgramsLOV: array
Partner Enrolled Programs
Title:
Partner Enrolled Programs
The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in. -
PartnerLevel: string
Title:
Level
Maximum Length:50
The partner level code. -
PartnerLevelMeaning: string
Title:
Level
Read Only:true
Maximum Length:80
The partner level meaning. -
PartnerStatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The partner status meaning. -
PartnerType: string
Title:
Type
Read Only:true
A Concatenated list of Partner Types. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party.. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the partner. -
PartyUniqueName: string
Title:
Partner Name
Read Only:true
Maximum Length:900
The unique name of the partner. -
PostalCode: string
Title:
Postal Code
Read Only:true
Maximum Length:60
The postal code of the partner address. -
SelectPartner: boolean
Indicates whether the partner can be selected. This attribute is internal.
-
State: string
Title:
State
Read Only:true
Maximum Length:60
The state of the partner address. -
Status: string
Title:
Status
Maximum Length:50
The partner status code. -
TerritoryCode: string
Title:
Territory Code
Read Only:true
Maximum Length:2
The territory code. -
TerritoryShortName: string
Title:
Country
Read Only:true
Maximum Length:80
The territory short name.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Partner Contact Managers
Type:
array
Title:
Partner Contact Managers
The partner contact managers list of values resource is used to view a list of partner contacts in a managerial role.
Show Source
Nested Schema : Partner Types
Type:
array
Title:
Partner Types
The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, or distributor.
Show Source
Nested Schema : Partner Enrolled Programs
Type:
array
Title:
Partner Enrolled Programs
The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in.
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 : partnersLOV-partnerContactManagersLOV-item-response
Type:
Show Source
object
-
AttachmentEntityName: string
Read Only:
true
Default Value:HZ_PARTIES
The name of the attachment entity. This attribute is internal. -
ChildRoleRelateId: integer
Read Only:
true
The unique identifier of the child role. This attribute is internal. -
DenormLevel: number
Read Only:
true
The denormination level. This attribute is internal. -
DenormMgrId: integer
Read Only:
true
The denormination manager id. This attribute is internal. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
The date when the role of the manager ends. This attribute is internal. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
The date when the role of the manager starts. This attribute is internal. -
EndDateActive: string
(date)
Title:
To Date
Read Only:true
The date when the record ends. This attribute is internal. -
FndTreeCode: string
Title:
Tree Code
Read Only:true
Maximum Length:30
The tree code. This attribute is internal. -
FndTreeStructureCode: string
Title:
Tree Structure Code
Read Only:true
Maximum Length:30
The tree structure code. This attribute is internal. -
FndTreeVersionId: string
Title:
Tree Version ID
Read Only:true
Maximum Length:32
The unique identifier of the tree version. This attribute is internal. -
GroupId: integer
Title:
Group ID
Read Only:true
The unique identifier of the group. This attribute is internal. -
GroupMemberId: integer
Read Only:
true
The unique identifier of the group member. -
HierarchyType: string
Read Only:
true
Maximum Length:240
The hierarchy type. This attribute is internal. -
ImageURL: string
Read Only:
true
The url of the image. This attribute is internal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager
Read Only:true
The name of the manager. -
Name: string
Title:
Organization
Read Only:true
Maximum Length:240
The name of the partner contact manager. This attribute is internal. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number. This attribute is internal. -
OrganizationId: integer
(int64)
Read Only:
true
The unique identifier of the organization. This attribute is internal. -
ParentOrgId: integer
(int64)
Read Only:
true
The unique identifier of the parent organization. This attribute is internal. -
ParentResourceId: integer
Read Only:
true
The unique identifier of the parent resource. This attribute is internal. -
ParRoleRelateId: integer
Read Only:
true
The unique identifier of the partner role related. This attribute is internal. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party associated with the partner contact. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the partner contact. -
PartyType: string
Title:
Type
Read Only:true
Maximum Length:30
The party type. This attribute is internal. -
PersonFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the person. This attribute is internal. -
PersonLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the person. This attribute is internal. -
ResourceId: integer
Read Only:
true
The unique identifier of the resource. This attribute is internal. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The resource name. This attribute is internal. -
RoleCode: string
Read Only:
true
Maximum Length:30
The code indicating the role of the partner contact. -
RoleId: integer
Read Only:
true
The unique identifier of the partner contact role. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the partner contact role. -
RoleRelateId: integer
Read Only:
true
The unique identifier of the related role. This attribute is internal. -
RoleResourceId: integer
Read Only:
true
The unique identifier of the role resource.This attribute is internal. -
RoleResourceType: string
Read Only:
true
Maximum Length:30
The role resource type. This attribute is internal. -
StartDateActive: string
(date)
Title:
From Date
Read Only:true
The date when the record starts. This attribute is internal. -
SysEffectiveDate: string
(date)
The system effective date. This attribute is internal.
-
TreeCode: string
Read Only:
true
Maximum Length:30
The tree code. This attribute is internal. -
TreeEffectiveEndDate: string
(date)
Title:
Effective End Date
Read Only:true
The effective end date. This attribute is internal. -
TreeEffectiveStartDate: string
(date)
Title:
Effective Start Date
Read Only:true
The effective start date. This attribute is internal. -
TreeStatus: string
Read Only:
true
Maximum Length:30
The tree status. This attribute is internal. -
TreeStructureCode: string
Read Only:
true
Maximum Length:30
The tree structure code. This attribute is internal. -
TreeVersionId: string
Read Only:
true
Maximum Length:32
The unique identifier of the tree version.This attribute is internal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partnersLOV-partnerDimensionsLOV-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
DimSubtypeCode: string
Maximum Length:
30
This attribute is internal. -
IntegrationId: string
Maximum Length:
80
The reference to the actual dimension member item. -
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The company number of the partner company. -
PartnerDimMembersId: integer
(int64)
This column is the private key of this table.
-
PartnerTypeCode: string
Title:
Partner Type
Maximum Length:30
The partner type code. -
PartnerTypeName: string
Title:
Type
Maximum Length:360
The partner type name. For example: Value Added Reseller, etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partnersLOV-partnerEnrolledProgramsLOV-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date)
Title:
Approval Date
Read Only:true
The date when the enrollment was approved. -
EnrollmentNumber: string
Title:
Enrollment Number
Read Only:true
Maximum Length:30
The alternate key identifier of the enrollment. -
EnrollmentStatus: string
Title:
Status
Read Only:true
Maximum Length:30
The status of the enrollment, such as draft, pending, approved, rejected, terminated, or renewed. -
ExpirationDate: string
(date)
Title:
End Date
Read Only:true
The date when the enrollment expires. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerPartyId: number
Read Only:
true
The unique identifier of the partner. -
PartnerProgramId: number
Title:
Program ID
Read Only:true
The unique identifier of the partner program. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the partner organization's party. -
PartyName: string
Title:
Organization
Read Only:true
Maximum Length:360
The name of the partner organization. -
ProgramEnrollmentId: integer
Title:
Program Enrollment ID
Read Only:true
The unique identifier of the partner program enrollment. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:150
The name of the partner program. -
ProgramNumber: string
Title:
Program Number
Read Only:true
Maximum Length:30
The alternate key identifier of the program. -
ProgramTermExpiryWarn: string
Read Only:
true
Maximum Length:30
The message that is displayed before the program term expiry. -
ProgramType: string
Title:
Program Type
Read Only:true
Maximum Length:30
The type of various partner programs, such as reseller or go to market. -
RecordSet: string
Read Only:
true
The record set associated with the program. -
RemainingDays: string
Title:
Remaining Days
Read Only:true
The number of days left before the enrollment expires. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the program enrollment begins. -
StatusCode: string
Title:
Program Status Code
Read Only:true
Maximum Length:30
The code indicating the status of the enrollment. -
SubmissionDate: string
(date)
Title:
Submission Date
Read Only:true
The date when the enrollment was submitted.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- partnerContactManagersLOV
-
Operation: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerContactManagersLOVParameters:
- partnersLOVUniqID:
$request.path.partnersLOVUniqID
The partner contact managers list of values resource is used to view a list of partner contacts in a managerial role. - partnersLOVUniqID:
- partnerDimensionsLOV
-
Operation: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerDimensionsLOVParameters:
- partnersLOVUniqID:
$request.path.partnersLOVUniqID
The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, or distributor. - partnersLOVUniqID:
- partnerEnrolledProgramsLOV
-
Operation: /crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerEnrolledProgramsLOVParameters:
- partnersLOVUniqID:
$request.path.partnersLOVUniqID
The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in. - partnersLOVUniqID: