Jump to

• Request
• Response

Update one rule

patch

/fscmRestApi/resources/11.13.18.05/assetGroupRules/{RuleId}

Request

Path Parameters

• RuleId(required): 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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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
        },
        "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-patch-request"
            }
        },
        "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"
            }
        },
        "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
        },
        "usages":{
            "title":"Usages",
            "type":"array",
            "description":"The Usages resource manages the usage defined for the group rule.",
            "items":{
                "$ref":"#/components/schemas/assetGroupRules-usages-item-patch-request"
            }
        },
        "RuleCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the asset group rule.",
            "nullable":false
        },
        "RuleName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the asset group rule.",
            "nullable":false
        },
        "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
        }
    }
}

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-patch-request

{
    "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-patch-request"
    }
}

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-patch-request

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

Nested Schema : assetGroupRules-groupingAttributes-item-patch-request

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.
• 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
        },
        "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"
            }
        },
        "AttributeName":{
            "type":"string",
            "description":"Name of the grouping attribute. You can provide either the attribute code or the attribute name.",
            "nullable":true
        }
    }
}

Nested Schema : assetGroupRules-usages-item-patch-request

Type: object

Show Source

• 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
        },
        "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"
            }
        },
        "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"
                ]
            }
        }
    }
}

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-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"
    }
}

Links

groupingAttributes

Operation: /fscmRestApi/resources/11.13.18.05/assetGroupRules/{RuleId}/child/groupingAttributes

Parameters:

• RuleId: $request.path.RuleId

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

usages

Operation: /fscmRestApi/resources/11.13.18.05/assetGroupRules/{RuleId}/child/usages

Parameters:

• RuleId: $request.path.RuleId

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

Back to Top