Get one group

get

/fscmRestApi/resources/11.13.18.05/assetGroups/{GroupId}

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : assetGroups-item-response
Type: object
Show Source
Nested Schema : Assignments
Type: array
Title: Assignments
The Assignments resource manages the assignment and detachment of assets from groups.
Show Source
Nested Schema : Grouping Attribute Values
Type: array
Title: Grouping Attribute Values
The Grouping Attribute Values resource stores values for the grouping attributes as defined in the grouping rule.
Show Source
Nested Schema : Group Members
Type: array
Title: Group Members
The Group Members resource stores members of groups.
Show Source
Nested Schema : Asset Validation Rules
Type: array
Title: Asset Validation Rules
The Asset Validation Rules resource stores values for the excluded assets in the group.
Show Source
Nested Schema : assetGroups-assignments-item-response
Type: object
Show Source
  • Value that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.
  • Maximum Length: 255
    Default Value: BaseAssetNumber
    Number that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.
  • Title: Assignment End Date
    Date when the assignment becomes inactive. This attribute is read-only.
  • Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.
  • Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.
  • Links
Nested Schema : assetGroups-groupingAttributeValues-item-response
Type: object
Show Source
  • Abbreviation that uniquely identifies the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.
  • Name of the attribute. You can provide either the attribute code or the attribute name. A grouping attribute identifier is required to create the grouping attribute value.
  • Value for the attribute for the group. This attribute is required.
  • Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.
  • Links
Nested Schema : assetGroups-groupMember-item-response
Type: object
Show Source
Nested Schema : assetGroups-validationRule-item-response
Type: object
Show Source
  • Links
  • Maximum Length: 30
    Abbreviation that uniquely identifies the asset validation rule. You can provide either the validation code or name.
  • Maximum Length: 255
    Name of the asset validation rule. You can provide either the validation code or name. Valid values are Exclude Asset from Contract and Exclude Asset from Service Request.
  • Value that uniquely identifies the group validation rule. The application generates this value when it creates the group validation rule. This attribute is read-only.
Back to Top