Get a user assignment group
get
/fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}
Request
Path Parameters
-
GroupId(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : userAssignmentGroups-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the user assignment group. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the user assignment group was created. -
eligibleUsers: array
Eligible Users
Title:
Eligible Users
To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group. -
GroupId: string
Read Only:
true
Maximum Length:100
The ID of the user assignment group. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the user assignment group was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who updated the user assignment group most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberCount: integer
Read Only:
true
The number of members of the user assignment group. -
members: array
Group Members
Title:
Group Members
The security administrator may add users to a user assignment group, or remove them. -
Name: string
Maximum Length:
200
The group's name. -
OrphanCount: integer
Read Only:
true
The number of orphan (inactive) members of the user assignment group. -
PrivilegeCode: string
Read Only:
true
Maximum Length:100
The privilege code associated to the user assignment group. -
RoleType: string
Maximum Length:
100
The group's authorization. -
SecurableType: string
Maximum Length:
100
The object type to be secured by the group. -
securityAssignments: array
Group Security Assignments
Title:
Group Security Assignments
A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.
Nested Schema : Eligible Users
Type:
array
Title:
Eligible Users
To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Group Members
Type:
array
Title:
Group Members
The security administrator may add users to a user assignment group, or remove them.
Show Source
Nested Schema : Group Security Assignments
Type:
array
Title:
Group Security Assignments
A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group.
Show Source
Nested Schema : userAssignmentGroups-eligibleUsers-item-response
Type:
Show Source
object
-
DisplayName: string
Read Only:
true
Maximum Length:128
The eligible user's display name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
The eligible user's person ID. -
RoleType: string
Read Only:
true
Maximum Length:128
Authorization that qualifies this user to be eligible as an owner, editor, or viewer. -
SecurableType: string
Read Only:
true
Maximum Length:255
Object for which this user qualifies to be eligible. -
UserGuid: string
Read Only:
true
Maximum Length:64
The eligible user's GUID.
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.
Nested Schema : userAssignmentGroups-members-item-response
Type:
Show Source
object
-
Displayname: string
Read Only:
true
Maximum Length:302
The member's display name. -
GroupId: string
Maximum Length:
100
The member's group ID. -
Id: integer
(int64)
The member's ID.
-
IsOrphan: integer
(int32)
Default Value:
0
Either the member is valid or invalid. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
The member's person ID. -
UserId: string
Maximum Length:
100
The member's GUID. -
Username: string
Read Only:
true
Maximum Length:100
The member's user name.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : userAssignmentGroups-securityAssignments-item-response
Type:
Show Source
object
-
AccessorDisplayName: string
Read Only:
true
Maximum Length:240
The display name of a user, or the name of a group, granted a security assignment for a user assignment group. -
AccessorId: string
Maximum Length:
100
The GUID of a user, or the ID of a group, granted a security assignment for the group. -
AccessorType: string
Maximum Length:
20
A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the security assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the security assignment was created. -
Id: integer
(int64)
The unique identifier of the security assignment.
-
IsEditor: integer
(int32)
Indicates the user is assigned as an editor.
-
IsOwner: integer
(int32)
Indicates the user is assigned as an owner.
-
IsViewer: integer
(int32)
Indicates the user is assigned as a viewer.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the security assignment was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who most recently updated the security assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SecurableId: string
Maximum Length:
100
ID of the group that's being secured.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- eligibleUsers
-
Parameters:
- GroupId:
$request.path.GroupId
To add members to a user assignment group, a security administrator selects among users who are eligible, meaning that they're assigned roles enabling them to work with records of the object secured by the group. - GroupId:
- members
-
Parameters:
- GroupId:
$request.path.GroupId
The security administrator may add users to a user assignment group, or remove them. - GroupId:
- securityAssignments
-
Operation: /fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}/child/securityAssignmentsParameters:
- GroupId:
$request.path.GroupId
A security assignment group may itself be secured. The administrator who owns the group may add other users as owners, editors, or viewers of the group. - GroupId: