Jump to

• Request
• Response

Get one criterion

get

/fscmRestApi/resources/11.13.18.05/minMaxGroups/{minMaxGroupsUniqID}/child/GroupClassifications/{ClassificationId}/child/ClassCriterias/{CriteriaId}

Request

Path Parameters

• ClassificationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• CriteriaId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• minMaxGroupsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CatalogId and GroupId ---for the Classification Groups resource and used to uniquely identify an instance of Classification Groups. The client should not generate the hash key value. Instead, the client should query on the Classification Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Classification Groups.
  
  For example: minMaxGroups?q=CatalogId=<value1>;GroupId=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : minMaxGroups-GroupClassifications-ClassCriterias-item-response

Type: object

Show Source

• ClassificationCode: string
  Maximum Length: 120

  Identifier for the classification.
• ClassificationId: integer (int64)
  Value that uniquely identifies the classification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the criteria.
• CriteriaEntity: string
  Maximum Length: 20

  Identifier for the criteria entity
• CriteriaEntityName: string
  Read Only: true

  Maximum Length: 255

  Name of the criteria entity
• CriteriaId: integer (int64)
  Value that uniquely identifies the criteria.
• CriteriaOperator: string
  Maximum Length: 20

  Identifier for the criteria operator.
• CriteriaOperatorString: string
  Maximum Length: 255

  Name of the criteria operator.
• CriteriaValues: array Classification Criteria Values
  Title: Classification Criteria Values

  Classification criteria values used for grouping items.
• CriteriaValuesList: string
  Read Only: true

  Maximum Length: 255

  List of values for the criteria.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the criteria.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the criteria.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in associated with the most recent update of the criteria.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number.

{
    "type":"object",
    "properties":{
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the criteria.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaEntity":{
            "maxLength":20,
            "type":"string",
            "description":"Identifier for the criteria entity",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria entity",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CriteriaOperator":{
            "maxLength":20,
            "type":"string",
            "description":"Identifier for the criteria operator.",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaOperatorString":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria operator.",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaValues":{
            "title":"Classification Criteria Values",
            "type":"array",
            "description":"Classification criteria values used for grouping items.",
            "items":{
                "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-CriteriaValues-item-response"
            }
        },
        "CriteriaValuesList":{
            "maxLength":255,
            "type":"string",
            "description":"List of values for the criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the criteria.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign in associated with the most recent update of the criteria.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the criteria.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Classification Criteria Values

Type: array

Title: Classification Criteria Values

Classification criteria values used for grouping items.

Show Source

• Array of: object minMaxGroups-GroupClassifications-ClassCriterias-CriteriaValues-item-response

{
    "title":"Classification Criteria Values",
    "type":"array",
    "description":"Classification criteria values used for grouping items.",
    "items":{
        "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-CriteriaValues-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 : minMaxGroups-GroupClassifications-ClassCriterias-CriteriaValues-item-response

Type: object

Show Source

• CategoryName: string
  Maximum Length: 255

  Name of the category.
• ClassificationCode: string
  Maximum Length: 120

  Identifier for the classification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the criteria values.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the criteria values.
• CriteriaId: integer (int64)
  Value that uniquely identifies the criteria.
• CriteriaValue: string
  Maximum Length: 250

  Name of the criteria value.
• CriteriaValueId: integer (int64)
  Unique identifier of the criteria value.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the criteria value.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the criteria value.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  System login associated with the most recent update of the criteria value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the criteria values.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the criteria values.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CriteriaValue":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the criteria value.",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaValueId":{
            "type":"integer",
            "description":"Unique identifier of the criteria value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the criteria value.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"System login associated with the most recent update of the criteria value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the criteria value.",
            "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"
    }
}

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

Links

CriteriaValues

Operation: /fscmRestApi/resources/11.13.18.05/minMaxGroups/{minMaxGroupsUniqID}/child/GroupClassifications/{ClassificationId}/child/ClassCriterias/{CriteriaId}/child/CriteriaValues

Parameters:

• ClassificationId: $request.path.ClassificationId
• CriteriaId: $request.path.CriteriaId
• minMaxGroupsUniqID: $request.path.minMaxGroupsUniqID

Classification criteria values used for grouping items.

Back to Top