Jump to

• Request
• Response

Get all partner contact managers

get

/crmRestApi/resources/11.13.18.05/partnersLOV/{partnersLOVUniqID}/child/partnerContactManagersLOV

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>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ManagersLOVFinder: Find all contacts defined as Manager Resources.
    Finder Variables:
    • BindSysEffectiveDate; string; The effective date.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AttachmentEntityName; string; The name of the attachment entity. This attribute is internal.
  • ChildRoleRelateId; integer; The unique identifier of the child role. This attribute is internal.
  • DenormLevel; number; The denormination level. This attribute is internal.
  • DenormMgrId; integer; The denormination manager id. This attribute is internal.
  • EffectiveEndDate; string; The date when the role of the manager ends. This attribute is internal.
  • EffectiveStartDate; string; The date when the role of the manager starts. This attribute is internal.
  • EndDateActive; string; The date when the record ends. This attribute is internal.
  • FndTreeCode; string; The tree code. This attribute is internal.
  • FndTreeStructureCode; string; The tree structure code. This attribute is internal.
  • FndTreeVersionId; string; The unique identifier of the tree version. This attribute is internal.
  • GroupId; integer; The unique identifier of the group. This attribute is internal.
  • GroupMemberId; integer; The unique identifier of the group member.
  • HierarchyType; string; The hierarchy type. This attribute is internal.
  • ImageURL; string; The url of the image. This attribute is internal.
  • ManagerName; string; The name of the manager.
  • Name; string; The name of the partner contact manager. This attribute is internal.
  • ObjectVersionNumber; integer; The object version number. This attribute is internal.
  • OrganizationId; integer; The unique identifier of the organization. This attribute is internal.
  • ParRoleRelateId; integer; The unique identifier of the partner role related. This attribute is internal.
  • ParentOrgId; integer; The unique identifier of the parent organization. This attribute is internal.
  • ParentResourceId; integer; The unique identifier of the parent resource. This attribute is internal.
  • PartyId; integer; The unique identifier of the party associated with the partner contact.
  • PartyName; string; The name of the party associated with the partner contact.
  • PartyType; string; The party type. This attribute is internal.
  • PersonFirstName; string; The first name of the person. This attribute is internal.
  • PersonLastName; string; The last name of the person. This attribute is internal.
  • ResourceId; integer; The unique identifier of the resource. This attribute is internal.
  • ResourceName; string; The resource name. This attribute is internal.
  • RoleCode; string; The code indicating the role of the partner contact.
  • RoleId; integer; The unique identifier of the partner contact role.
  • RoleName; string; The name of the partner contact role.
  • RoleRelateId; integer; The unique identifier of the related role. This attribute is internal.
  • RoleResourceId; integer; The unique identifier of the role resource.This attribute is internal.
  • RoleResourceType; string; The role resource type. This attribute is internal.
  • StartDateActive; string; The date when the record starts. This attribute is internal.
  • SysEffectiveDate; string; The system effective date. This attribute is internal.
  • TreeCode; string; The tree code. This attribute is internal.
  • TreeEffectiveEndDate; string; The effective end date. This attribute is internal.
  • TreeEffectiveStartDate; string; The effective start date. This attribute is internal.
  • TreeStatus; string; The tree status. This attribute is internal.
  • TreeStructureCode; string; The tree structure code. This attribute is internal.
  • TreeVersionId; string; The unique identifier of the tree version.This attribute is internal.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 Top

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.

Body ()

Root Schema : partnersLOV-partnerContactManagersLOV

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/partnersLOV-partnerContactManagersLOV-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object partnersLOV-partnerContactManagersLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/partnersLOV-partnerContactManagersLOV-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : partnersLOV-partnerContactManagersLOV-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "DenormMgrId":{
            "type":"integer",
            "description":"The denormination manager id. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeEffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The effective start date. This attribute is internal.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FndTreeCode":{
            "title":"Tree Code",
            "maxLength":"30",
            "type":"string",
            "description":"The tree code. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HierarchyType":{
            "maxLength":"240",
            "type":"string",
            "description":"The hierarchy type. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SysEffectiveDate":{
            "type":"string",
            "description":"The system effective date. This attribute is internal.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParRoleRelateId":{
            "type":"integer",
            "description":"The unique identifier of the partner role related. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The resource name. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager",
            "type":"string",
            "description":"The name of the manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChildRoleRelateId":{
            "type":"integer",
            "description":"The unique identifier of the child role. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the partner contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the organization. This attribute is internal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the role of the partner contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenormLevel":{
            "type":"number",
            "description":"The denormination level. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the partner contact manager. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleRelateId":{
            "type":"integer",
            "description":"The unique identifier of the related role. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the record starts. This attribute is internal.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeVersionId":{
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier of the tree version.This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupMemberId":{
            "type":"integer",
            "description":"The unique identifier of the group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number. This attribute is internal.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "FndTreeVersionId":{
            "title":"Tree Version ID",
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier of the tree version. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleResourceId":{
            "type":"integer",
            "description":"The unique identifier of the role resource.This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The party type. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The role resource type. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"The tree status. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The date when the role of the manager ends. This attribute is internal.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the person. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "ImageURL":{
            "type":"string",
            "description":"The url of the image. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the person. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the partner contact role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FndTreeStructureCode":{
            "title":"Tree Structure Code",
            "maxLength":"30",
            "type":"string",
            "description":"The tree structure code. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "title":"Group ID",
            "type":"integer",
            "description":"The unique identifier of the group. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the record ends. This attribute is internal.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the partner contact role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentResourceId":{
            "type":"integer",
            "description":"The unique identifier of the parent resource. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeEffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The effective end date. This attribute is internal.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the partner contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource. This attribute is internal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeStructureCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The tree structure code. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The tree code. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The date when the role of the manager starts. This attribute is internal.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "type":"string",
            "description":"The name of the attachment entity. This attribute is internal.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "ParentOrgId":{
            "type":"integer",
            "description":"The unique identifier of the parent organization. This attribute is internal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top