1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Access Groups
  4. Access Group Members

Get all access group members

get

/crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers

Request

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

    • GroupNumberAndPartyNumberRF: Finds an access group member with the specified party number and access group number.
      Finder Variables:
      • AccessGroupNumber; string; The alternate key identifier for the access group.
      • PartyNumber; string; The alternate key identifier of the access group member.
    • PartyNumberAltKeyFinder: Finds an access group member with the specified party number.
      Finder Variables:
      • ManualAssignFlag; string; Indicates if access group members are assigned to a group manually or assigned based on a rule.
      • PartyNumber; string; The alternate key identifier for the access group member.
    • PrimaryKey: Finds an access group member with the specified primary key.
      Finder Variables:
      • AccessGroupMemberId; integer; The unique identifier of the access group member.
  • 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:
    • AccessGroupId; integer; The unique identifier of the access group.
    • AccessGroupMemberId; integer; The unique identifier of the access group member.
    • AccessGroupNumber; string; The alternate key identifier of the access group to which the access group member belongs.
    • CreatedBy; string; The user who created the access group member.
    • CreationDate; string; The date when the access group member was created.
    • EmailAddress; string; The email address of the access group member.
    • FormattedPhoneNumber; string; The phone number of the resource associated with the access group member.
    • LastUpdateDate; string; The date when the access group member was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the access group member.
    • LastUpdatedBy; string; The user who last updated the access group member.
    • ManualAssignFlag; boolean; Indicates whether a member has been added to the group manually.
    • Name; string; The name of the access group to which the access group member belongs.
    • PartyId; integer; The unique identifier of the access group member.
    • PartyName; string; The name of the access group member.
    • PartyNumber; string; The alternate key identifier for the resource.
    • RoleName; string; The role of the resource associated with the access group member.
    • TypeCode; string; The code indicating the parent access group type of the access group member.
  • 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 : accessGroups-AccessGroupMembers
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : accessGroups-AccessGroupMembers-item-response
Type: object
Show Source
  • Title: Access Group ID
    The unique identifier of the access group.
  • Title: Access Group Member ID
    The unique identifier of the access group member.
  • Title: Group Number
    Read Only: true
    Maximum Length: 4000
    The alternate key identifier of the access group to which the access group member belongs.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the access group member.
  • Title: Creation Date
    Read Only: true
    The date when the access group member was created.
  • Title: E-Mail
    Read Only: true
    Maximum Length: 320
    The email address of the access group member.
  • Title: Phone
    Read Only: true
    The phone number of the resource associated with the access group member.
  • Title: Last Update Date
    Read Only: true
    The date when the access group member was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the access group member.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the access group member.
  • Links
  • Title: Member Type
    Maximum Length: 1
    Default Value: true
    Indicates whether a member has been added to the group manually.
  • Title: Group Name
    Read Only: true
    Maximum Length: 4000
    The name of the access group to which the access group member belongs.
  • Title: Party ID
    The unique identifier of the access group member.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 255
    The name of the access group member.
  • Title: Resource Registry ID
    Read Only: true
    Maximum Length: 30
    The alternate key identifier for the resource.
  • Title: Resource Role
    Read Only: true
    The role of the resource associated with the access group member.
  • Title: Type Code
    Maximum Length: 30
    Default Value: ORA_ZCA_CUSTOM
    The code indicating the parent access group type of the access group member.
Back to Top

Examples

The following example shows how to get all access group members by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "AccessGroupId": 100100297398246,
            "AccessGroupMemberId": 100100298697939,
            "CreatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "CreationDate": "2021-03-20T00:31:13.031+00:00",
            "LastUpdateDate": "2021-03-20T00:31:13.031+00:00",
            "LastUpdateLogin": "53214D2D5C57A786E050F70A354D30CA",
            "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID",
            "ManualAssignFlag": false,
            "PartyId": 100010037456685,
            "TypeCode": "ORA_ZCA_ROLE",
            "PartyNumber": "100010037456685",
            "PartyName": " Davis,Timothy ",
            "EmailAddress": null,
            "Name": "All Users Group",
            "AccessGroupNumber": "ORA_FND_AUTHENTICATED_USER_ABSTRACT",
            "FormattedPhoneNumber": null,
            "RoleName": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroups/ORA_FND_AUTHENTICATED_USER_ABSTRACT/child/AccessGroupMembers/0002000000014E0000000F313030303130303337343536363835",
                    "name": "AccessGroupMembers",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
...
}
Back to Top