Create groups

post

/fscmRestApi/resources/11.13.18.05/assetGroups

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
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 : schema
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.
Nested Schema : assetGroups-groupingAttributeValues-item-post-request
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.
Nested Schema : assetGroups-groupMember-item-post-request
Type: object
Show Source
Nested Schema : assetGroups-validationRule-item-post-request
Type: object
Show Source
  • 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

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