Jump to

• Request
• Response

Get all rules

get

/fscmRestApi/resources/11.13.18.05/assetGroupRules

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:
  
  

  • PrimaryKey: Find asset group rules according to the rule identifier.
    Finder Variables:
    • RuleId; integer; Value that uniquely identifies the asset group rule.
• 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:
  

  • EnforceUniqueAssignmentFlag; boolean; Contains one of the following values: true or false. If true, then unique assignments of assets in the groups referring to the rule is enforced. If false then unique assignments of assets in the groups referring to the rules is not enforced. The default value is false.
  • InactiveOn; string; Date and time when the rule becomes inactive. When the rule is inactive you cannot add groups to it anymore.
  • RuleCode; string; Abbreviation that uniquely identifies the asset group rule.
  • RuleDescription; string; Description of the asset group rule.
  • RuleId; integer; Value that uniquely identifies the asset group rule. The application generates this value when it creates the rule. This attribute is read-only.
  • RuleName; string; Name of the asset group rule.
• 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 : assetGroupRules

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/assetGroupRules-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 assetGroupRules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assetGroupRules-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 : assetGroupRules-item-response

Type: object

Show Source

• EnforceUniqueAssignmentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then unique assignments of assets in the groups referring to the rule is enforced. If false then unique assignments of assets in the groups referring to the rules is not enforced. The default value is false.
• groupingAttributes: array Grouping Attributes
  Title: Grouping Attributes

  The Grouping Attributes resource manages the grouping attribute list defined for the rule.
• InactiveOn: string (date)
  Title: Inactive On

  Date and time when the rule becomes inactive. When the rule is inactive you cannot add groups to it anymore.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the asset group rule.
• RuleDescription: string
  Title: Description

  Maximum Length: 240

  Description of the asset group rule.
• RuleId: integer (int64)
  Value that uniquely identifies the asset group rule. The application generates this value when it creates the rule. This attribute is read-only.
• RuleName: string
  Title: Name

  Maximum Length: 120

  Name of the asset group rule.
• usages: array Usages
  Title: Usages

  The Usages resource manages the usage defined for the group rule.

{
    "type":"object",
    "properties":{
        "RuleDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset group rule.",
            "nullable":true,
            "x-queryable":true
        },
        "groupingAttributes":{
            "title":"Grouping Attributes",
            "type":"array",
            "description":"The Grouping Attributes resource manages the grouping attribute list defined for the rule.",
            "items":{
                "$ref":"#/components/schemas/assetGroupRules-groupingAttributes-item-response"
            }
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset group rule. The application generates this value when it creates the rule. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EnforceUniqueAssignmentFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then unique assignments of assets in the groups referring to the rule is enforced. If false then unique assignments of assets in the groups referring to the rules is not enforced. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "usages":{
            "title":"Usages",
            "type":"array",
            "description":"The Usages resource manages the usage defined for the group rule.",
            "items":{
                "$ref":"#/components/schemas/assetGroupRules-usages-item-response"
            }
        },
        "RuleCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset group rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the asset group rule.",
            "nullable":false,
            "x-queryable":true
        },
        "InactiveOn":{
            "title":"Inactive On",
            "type":"string",
            "description":"Date and time when the rule becomes inactive. When the rule is inactive you cannot add groups to it anymore.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Grouping Attributes

Type: array

Title: Grouping Attributes

The Grouping Attributes resource manages the grouping attribute list defined for the rule.

Show Source

• Array of: object assetGroupRules-groupingAttributes-item-response

{
    "title":"Grouping Attributes",
    "type":"array",
    "description":"The Grouping Attributes resource manages the grouping attribute list defined for the rule.",
    "items":{
        "$ref":"#/components/schemas/assetGroupRules-groupingAttributes-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 : Usages

Type: array

Title: Usages

The Usages resource manages the usage defined for the group rule.

Show Source

• Array of: object assetGroupRules-usages-item-response

{
    "title":"Usages",
    "type":"array",
    "description":"The Usages resource manages the usage defined for the group rule.",
    "items":{
        "$ref":"#/components/schemas/assetGroupRules-usages-item-response"
    }
}

Nested Schema : assetGroupRules-groupingAttributes-item-response

Type: object

Show Source

• AttributeCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the grouping attribute. You can provide either the attribute code or the attribute name.
• AttributeName: string
  Name of the grouping attribute. You can provide either the attribute code or the attribute name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleGroupingAttributeId: integer (int64)
  Value that uniquely identifies the rule grouping attribute. The application generates this value when it creates the rule. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the grouping attribute. You can provide either the attribute code or the attribute name.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleGroupingAttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule grouping attribute. The application generates this value when it creates the 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"
            }
        },
        "AttributeName":{
            "type":"string",
            "description":"Name of the grouping attribute. You can provide either the attribute code or the attribute name.",
            "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 : 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 : assetGroupRules-usages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleUsageId: integer (int64)
  Value that uniquely identifies the rule usage. The application generates this value when it creates the rule. This attribute is read-only.
• UsageCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the usage. You can provide either the usage code or the usage name.
• UsageName: string
  Name of the usage. You can provide either the usage code or the usage name.

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the usage. You can provide either the usage code or the usage name.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleUsageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule usage. The application generates this value when it creates the rule. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UsageName":{
            "type":"string",
            "description":"Name of the usage. You can provide either the usage code or the usage name.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning"
                ]
            },
            "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