1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. List of Values
  4. Partners

Get all partners

get

/crmRestApi/resources/11.13.18.05/partnersLOV

Request

Query Parameters
  • 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).
  • 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
  • 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:

    • ActivePartnersFinder: Finds all active partners with the specified finder.
      Finder Variables:
      • BindDefaultStatus; string; The bind default status. This is optional. This need not be passed.
      • BindExtraStatus; string; The bind extra status. This is optional. This need not be passed.
    • PrimaryKey: Finds a partner using party identifier.
      Finder Variables:
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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:
      • AccountDirectorId; integer; The unique identifier of the owner resource for this partner.
      • Address; string; That address of the partner.
      • City; string; The city name of the partner address.
      • CompanyNumber; string; The alternate key identifier of the partner's company.
      • Country; string; The country associated with the partner.
      • Location; string; The location of the address.
      • LookupCode; string; The lookup code. This attribute is internal.
      • LookupType; string; The lookup type. This attribute is internal.
      • PartnerAccountId; integer; The unique identifier of the partner account. This attribute is internal.
      • PartnerLevel; string; The partner level code.
      • PartnerLevelMeaning; string; The partner level meaning.
      • PartnerStatusMeaning; string; The partner status meaning.
      • PartnerType; string; A Concatenated list of Partner Types.
      • PartyId; integer; The unique identifier of the party..
      • PartyName; string; The name of the partner.
      • PartyUniqueName; string; The unique name of the partner.
      • PostalCode; string; The postal code of the partner address.
      • State; string; The state of the partner address.
      • Status; string; The partner status code.
      • TerritoryCode; string; The territory code.
      • TerritoryShortName; string; The territory short name.
    • 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
    • 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".
    • 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

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : partnersLOV-item-response
    Type: object
    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 : partnersLOV-partnerContactManagersLOV-item-response
    Type: object
    Show Source
    Nested Schema : partnersLOV-partnerDimensionsLOV-item-response
    Type: object
    Show Source
    Nested Schema : partnersLOV-partnerEnrolledProgramsLOV-item-response
    Type: object
    Show Source
    Back to Top