Jump to

• Request
• Response

Get all item rule sets

get

/fscmRestApi/resources/11.13.18.05/itemRuleSets

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 Finds an item rule set according to the specified primary key criteria.
    Finder Variables
    • RuleSetId; integer; Finds an item rule set by the RuleSetId; integer; attribute.
• 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:
  

  • Association1KeyValue; string; Name of first association for the item rule set.
  • Association2KeyValue; string; Name of second association for the item rule set.
  • AssociationType; string; Value that uniquely identifies the association of the item rule set to the object.
  • Composite; string; Contains one of the following values: Y or N. If Y, then the item rule set will be a composite. If N, then the item rule set won't be a composite. The default value is N. Composite functionality allow multiple item rule sets in a master rule set.
  • CreatedBy; string; User who created the item rule set.
  • CreationDate; string; Date and time when the user created the item rule set.
  • Description; string; Description for the item rule set.
  • IsDraft; string; Contains one of the following values: Y or null. If Y, then the item rule set will be draft rule set. If null, then the item rule set will be production. The default value is null. Draft status prevents the rule from being triggered during item transactions, and allows rule impact analysis on the rule set.
  • LastUpdateDate; string; Date and time when the user most recently updated the item rule set.
  • LastUpdatedBy; string; User who most recently updated the item rule set.
  • RuleSetDisplayName; string; Display name of an item rule set.
  • RuleSetId; integer; Value that uniquely identifies an item rule set.
  • RuleSetInternalName; string; Name of a item rule set.
  • RuleSetType; string; Value that uniquely identifies the item rule set type.
  • RulesImplementation; string; Value that uniquely identifies the implementation of the item rule set.
• 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: string
  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: string
  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 : itemRuleSets

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/itemRuleSets-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"ProductCatalogManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object itemRuleSets-item-response

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

Type: object

Show Source

• Association1KeyValue: string
  Title: Association Name

  Read Only: true

  Maximum Length: 30

  Name of first association for the item rule set.
• Association2KeyValue: string
  Read Only: true

  Maximum Length: 80

  Name of second association for the item rule set.
• AssociationType: string
  Title: Association Type

  Read Only: true

  Maximum Length: 10

  Value that uniquely identifies the association of the item rule set to the object.
• Composite: string
  Title: Composite

  Read Only: true

  Maximum Length: 50

  Contains one of the following values: Y or N. If Y, then the item rule set will be a composite. If N, then the item rule set won't be a composite. The default value is N. Composite functionality allow multiple item rule sets in a master rule set.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the item rule set.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the item rule set.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 256

  Description for the item rule set.
• IsDraft: string
  Read Only: true

  Maximum Length: 2

  Contains one of the following values: Y or null. If Y, then the item rule set will be draft rule set. If null, then the item rule set will be production. The default value is null. Draft status prevents the rule from being triggered during item transactions, and allows rule impact analysis on the rule set.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the item rule set.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the item rule set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleSetDisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 50

  Display name of an item rule set.
• RuleSetId: integer (int64)
  Read Only: true

  Value that uniquely identifies an item rule set.
• RuleSetInternalName: string
  Title: Internal Name

  Read Only: true

  Maximum Length: 50

  Name of a item rule set.
• RuleSetType: string
  Title: Type

  Read Only: true

  Maximum Length: 50

  Value that uniquely identifies the item rule set type.
• RulesImplementation: string
  Read Only: true

  Maximum Length: 20

  Value that uniquely identifies the implementation of the item rule set.
• translatableAttributes: array Translatable Attributes
  Title: Translatable Attributes

  Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets.

{
    "type":"object",
    "properties":{
        "IsDraft":{
            "maxLength":2,
            "type":"string",
            "description":"Contains one of the following values: Y or null. If Y, then the item rule set will be draft rule set. If null, then the item rule set will be production. The default value is null. Draft status prevents the rule from being triggered during item transactions, and allows rule impact analysis on the rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the item rule set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Association1KeyValue":{
            "title":"Association Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of first association for the item rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSetDisplayName":{
            "title":"Display Name",
            "maxLength":50,
            "type":"string",
            "description":"Display name of an item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":256,
            "type":"string",
            "description":"Description for the item rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Composite":{
            "title":"Composite",
            "maxLength":50,
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then the item rule set will be a composite. If N, then the item rule set won't be a composite. The default value is N. Composite functionality allow multiple item rule sets in a master rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Association2KeyValue":{
            "maxLength":80,
            "type":"string",
            "description":"Name of second association for the item rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RulesImplementation":{
            "maxLength":20,
            "type":"string",
            "description":"Value that uniquely identifies the implementation of the item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSetType":{
            "title":"Type",
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the item rule set type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies an item rule set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RuleSetInternalName":{
            "title":"Internal Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of a item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationType":{
            "title":"Association Type",
            "maxLength":10,
            "type":"string",
            "description":"Value that uniquely identifies the association of the item rule set to the object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "translatableAttributes":{
            "title":"Translatable Attributes",
            "type":"array",
            "description":"Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets.",
            "items":{
                "$ref":"#/components/schemas/itemRuleSets-translatableAttributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the item rule set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : Translatable Attributes

Type: array

Title: Translatable Attributes

Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets.

Show Source

• Array of: object itemRuleSets-translatableAttributes-item-response

{
    "title":"Translatable Attributes",
    "type":"array",
    "description":"Contains translated content for item rule sets based on the value for the language attribute. The description and display name for the rule set attributes are translatable for rule sets.",
    "items":{
        "$ref":"#/components/schemas/itemRuleSets-translatableAttributes-item-response"
    }
}

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 : itemRuleSets-translatableAttributes-item-response

Type: object

Show Source

• CreationDateTime: string (date-time)
  Read Only: true

  Date and time when the user created the translated item rule set.
• Description: string
  Read Only: true

  Maximum Length: 256

  Description for the translated item rule set.
• Language: string
  Read Only: true

  Maximum Length: 4

  Name of the language associated with the item rule set.
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the translated item rule set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RuleSetDisplayName: string
  Read Only: true

  Maximum Length: 50

  Display name of a translated item rule set.
• RuleSetId: integer (int64)
  Read Only: true

  Value that uniquely identifies a translated item rule set.
• SourceLanguage: string
  Read Only: true

  Maximum Length: 4

  Name of the source language associated with item rule set.

{
    "type":"object",
    "properties":{
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Name of the source language associated with item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies a translated item rule set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RuleSetDisplayName":{
            "maxLength":50,
            "type":"string",
            "description":"Display name of a translated item rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":256,
            "type":"string",
            "description":"Description for the translated item rule set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the translated item rule set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Name of the language associated with the item rule set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the translated item rule set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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