Get an access group
get
/crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}
Request
Path Parameters
-
AccessGroupNumber(required): string
The alternate key identifier for the access group. It is a unique system generated sequence number.
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 : accessGroups-item-response
Type:
Show Source
object
-
AccessGroupId: integer
(int64)
Title:
Access Group ID
The unique identifier of the access group. -
AccessGroupMembers: array
Access Group Members
Title:
Access Group Members
The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group. -
AccessGroupNumber: string
Title:
Number
Maximum Length:4000
The alternate key identifier for the access group. It is a unique system generated sequence number. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates whether the access group is active or not. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the access group. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the access group was created. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Default Value:true
Indicates whether the record can be deleted. -
Description: string
Title:
Description
Maximum Length:4000
The description of the access group. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date on which the access group was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the access group. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the access group. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:4000
The name of the access group. -
TypeCode: string
Title:
Type
Maximum Length:30
Default Value:ORA_ZCA_CUSTOM
The code indicating the type of the access group. -
TypeCodeMeaning: string
Title:
Type
Read Only:true
Maximum Length:80
The type of the access group. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Default Value:true
Indicates whether the record can be updated.
Nested Schema : Access Group Members
Type:
array
Title:
Access Group Members
The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accessGroups-AccessGroupMembers-item-response
Type:
Show Source
object
-
AccessGroupId: integer
(int64)
Title:
Access Group ID
The unique identifier of the access group. -
AccessGroupMemberId: integer
(int64)
Title:
Access Group Member ID
The unique identifier of the access group member. -
AccessGroupNumber: string
Title:
Group Number
Read Only:true
Maximum Length:4000
The alternate key identifier of the access group to which the access group member belongs. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the access group member. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the access group member was created. -
EmailAddress: string
Title:
E-Mail
Read Only:true
Maximum Length:320
The email address of the access group member. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the resource associated with the access group member. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the access group member was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the access group member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the access group member. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualAssignFlag: boolean
Title:
Member Type
Maximum Length:1
Default Value:true
Indicates whether a member has been added to the group manually. -
Name: string
Title:
Group Name
Read Only:true
Maximum Length:4000
The name of the access group to which the access group member belongs. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the access group member. -
PartyName: string
Title:
Resource Name
Read Only:true
Maximum Length:255
The name of the access group member. -
PartyNumber: string
Title:
Resource Registry ID
Read Only:true
Maximum Length:30
The alternate key identifier for the resource. -
RoleName: string
Title:
Resource Role
Read Only:true
The role of the resource associated with the access group member. -
TypeCode: string
Title:
Type Code
Maximum Length:30
Default Value:ORA_ZCA_CUSTOM
The code indicating the parent access group type of the access group member.
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
- AccessGroupMembers
-
Operation: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembersParameters:
- AccessGroupNumber:
$request.path.AccessGroupNumber
The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group. - AccessGroupNumber:
Examples
The following example shows how to get an access group 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/CDRM_1
Example of Response Body
The following shows an example of the response body in JSON format.
{
"AccessGroupId": 300100182647465,
"AccessGroupNumber": "CDRM_1",
"ActiveFlag": false,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2020-01-07T06:48:00+00:00",
"Description": "Demo Group Description",
"LastUpdateDate": "2020-01-07T06:48:00.425+00:00",
"LastUpdateLogin": "99EB11C2CFA55443E05392BDF20ABC87",
"LastUpdatedBy": "SALES_ADMIN",
"Name": "Demo Group",
"TypeCode": "CUSTOM",
"UpdateFlag": true,
"DeleteFlag": false,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroups/CDRM_1",
"name": "accessGroups",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
...
}