Jump to

• Request
• Response

Get all groups

get

/fscmRestApi/resources/11.13.18.05/assetGroups

Request

Query Parameters

• 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
• finder: string
  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:
  
  

  • GroupsByAssetId: Finds group member according to the asset identifier.
    Finder Variables:
    • BindAssetId; integer; Value that uniquely identifies the asset. This attribute is a foreign key.
  • PrimaryKey: Finds asset groups according to the group identifier.
    Finder Variables:
    • GroupId; integer; Value that uniquely identifies the group. This attribute is a primary key.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • GroupDescription; string; Description of the asset group. You can use this attribute to describe the group features, characteristics, and so on.
  • GroupId; integer; Value that uniquely identifies the group. The application generates this value when it creates the group. This attribute is read-only.
  • GroupName; string; Name of the asset group. If you don't provide a value, the application uses the group number.
  • GroupNumber; string; Number that identifies the group. This attribute is optional. If you don't provide a value, the application uses the group identifier.
  • GroupRuleCode; string; Abbreviation that uniquely identifies the asset group rule with which the group is associated.
  • GroupRuleName; string; Name that identifies an asset group rule with which the group is associated.
  • InactiveOnDate; string; Date and time when the asset group becomes inactive. When the group becomes inactive you can't add assets to it anymore.
• totalResults: boolean
  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

• 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 Top

Response

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.

Body ()

Root Schema : assetGroups

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/assetGroups-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object assetGroups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assetGroups-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : assetGroups-item-response

Type: object

Show Source

• assignments: array Assignments
  Title: Assignments

  The Assignments resource manages the assignment and detachment of assets from groups.
• GroupDescription: string
  Title: Description

  Maximum Length: 240

  Description of the asset group. You can use this attribute to describe the group features, characteristics, and so on.
• GroupId: integer (int64)
  Value that uniquely identifies the group. The application generates this value when it creates the group. This attribute is read-only.
• groupingAttributeValues: array Grouping Attribute Values
  Title: Grouping Attribute Values

  The Grouping Attribute Values resource stores values for the grouping attributes as defined in the grouping rule.
• groupMember: array Group Members
  Title: Group Members

  The Group Members resource stores members of groups.
• GroupName: string
  Title: Name

  Maximum Length: 120

  Name of the asset group. If you don't provide a value, the application uses the group number.
• GroupNumber: string
  Title: Number

  Maximum Length: 30

  Number that identifies the group. This attribute is optional. If you don't provide a value, the application uses the group identifier.
• GroupRuleCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the asset group rule with which the group is associated.
• GroupRuleName: string
  Title: Group Rule

  Read Only: true

  Maximum Length: 120

  Name that identifies an asset group rule with which the group is associated.
• InactiveOnDate: string (date)
  Date and time when the asset group becomes inactive. When the group becomes inactive you can't add assets to it anymore.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• validationRule: array Asset Validation Rules
  Title: Asset Validation Rules

  The Asset Validation Rules resource stores values for the excluded assets in the group.

{
    "type":"object",
    "properties":{
        "GroupRuleName":{
            "title":"Group Rule",
            "maxLength":"120",
            "type":"string",
            "description":"Name that identifies an asset group rule with which the group is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the asset group. If you don't provide a value, the application uses the group number.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset group. You can use this attribute to describe the group features, characteristics, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "assignments":{
            "title":"Assignments",
            "type":"array",
            "description":"The Assignments resource manages the assignment and detachment of assets from groups.",
            "items":{
                "$ref":"#/components/schemas/assetGroups-assignments-item-response"
            }
        },
        "groupMember":{
            "title":"Group Members",
            "type":"array",
            "description":"The Group Members resource stores members of groups.",
            "items":{
                "$ref":"#/components/schemas/assetGroups-groupMember-item-response"
            }
        },
        "validationRule":{
            "title":"Asset Validation Rules",
            "type":"array",
            "description":"The Asset Validation Rules resource stores values for the excluded assets in the group.",
            "items":{
                "$ref":"#/components/schemas/assetGroups-validationRule-item-response"
            }
        },
        "GroupNumber":{
            "title":"Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the group. This attribute is optional. If you don't provide a value, the application uses the group identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupRuleCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset group rule with which the group is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "groupingAttributeValues":{
            "title":"Grouping Attribute Values",
            "type":"array",
            "description":"The Grouping Attribute Values resource stores values for the grouping attributes as defined in the grouping rule.",
            "items":{
                "$ref":"#/components/schemas/assetGroups-groupingAttributeValues-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InactiveOnDate":{
            "type":"string",
            "description":"Date and time when the asset group becomes inactive. When the group becomes inactive you can't add assets to it anymore.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group. The application generates this value when it creates the group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Assignments

Type: array

Title: Assignments

The Assignments resource manages the assignment and detachment of assets from groups.

Show Source

• Array of: object assetGroups-assignments-item-response

{
    "title":"Assignments",
    "type":"array",
    "description":"The Assignments resource manages the assignment and detachment of assets from groups.",
    "items":{
        "$ref":"#/components/schemas/assetGroups-assignments-item-response"
    }
}

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

• Array of: object assetGroups-groupingAttributeValues-item-response

{
    "title":"Grouping Attribute Values",
    "type":"array",
    "description":"The Grouping Attribute Values resource stores values for the grouping attributes as defined in the grouping rule.",
    "items":{
        "$ref":"#/components/schemas/assetGroups-groupingAttributeValues-item-response"
    }
}

Nested Schema : Group Members

Type: array

Title: Group Members

The Group Members resource stores members of groups.

Show Source

• Array of: object assetGroups-groupMember-item-response

{
    "title":"Group Members",
    "type":"array",
    "description":"The Group Members resource stores members of groups.",
    "items":{
        "$ref":"#/components/schemas/assetGroups-groupMember-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object assetGroups-validationRule-item-response

{
    "title":"Asset Validation Rules",
    "type":"array",
    "description":"The Asset Validation Rules resource stores values for the excluded assets in the group.",
    "items":{
        "$ref":"#/components/schemas/assetGroups-validationRule-item-response"
    }
}

Nested Schema : assetGroups-assignments-item-response

Type: object

Show Source

• AssetId: integer (int64)
  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.
• AssetNumber: string
  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.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  Date when the assignment becomes inactive. This attribute is read-only.
• GroupId: integer (int64)
  Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.
• GroupMemberId: integer (int64)
  Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GroupMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"BaseAssetNumber",
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"Date when the assignment becomes inactive. This attribute is read-only.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : assetGroups-groupingAttributeValues-item-response

Type: object

Show Source

• AttributeCode: string
  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.
• AttributeName: string
  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.
• AttributeValue: string
  Value for the attribute for the group. This attribute is required.
• GroupValueId: integer (int64)
  Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "GroupValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group attribute value. The application generates this value when it creates the group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttributeCode":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeValue":{
            "type":"string",
            "description":"Value for the attribute for the group. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : assetGroups-groupMember-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: Assignment End Date

  Date and time when the group member becomes inactive. When the group member becomes inactive you can't add a record to it anymore.
• AssetId: integer (int64)
  Value that stores the unique identifier of the asset.
• GroupId: integer (int64)
  Value that stores the unique identifier of the group.
• GroupMemberId: integer (int64)
  Value that uniquely identifies the group member. The application generates this value when it creates the group member. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GroupMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group member. The application generates this value when it creates the group member. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"Date and time when the group member becomes inactive. When the group member becomes inactive you can't add a record to it anymore.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that stores the unique identifier of the asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that stores the unique identifier of the group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : assetGroups-validationRule-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValidationCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the asset validation rule. You can provide either the validation code or name.
• ValidationName: string
  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.
• ValidationRuleId: integer (int64)
  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.

{
    "type":"object",
    "properties":{
        "ValidationRuleId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValidationName":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset validation rule. You can provide either the validation code or name.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top