Jump to

• Request
• Response

Create one classification group

post

/fscmRestApi/resources/11.13.18.05/minMaxGroups

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• Description(required): string
  Maximum Length: 120

  Description of the classification group.
• GroupClassifications: array Classifications
  Title: Classifications

  The classifications within the default classification group.
• GroupCode: string
  Maximum Length: 120

  Identifier for the classification group.
• GroupId: integer (int64)
  Value that uniquely identifies the classification group.
• GroupName(required): string
  Maximum Length: 20

  Name of the classification group.
• GrpCatalogName: string
  Maximum Length: 255

  Name of the catalog.

{
    "required":[
        "Description",
        "GroupName"
    ],
    "type":"object",
    "properties":{
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Description":{
            "maxLength":120,
            "type":"string",
            "description":"Description of the classification group.",
            "nullable":false
        },
        "GroupClassifications":{
            "title":"Classifications",
            "type":"array",
            "description":"The classifications within the default classification group.",
            "items":{
                "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-item-post-request"
            }
        },
        "GroupCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification group.",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "GroupName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the classification group.",
            "nullable":false
        },
        "GrpCatalogName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the catalog.",
            "nullable":true
        }
    }
}

Nested Schema : Classifications

Type: array

Title: Classifications

The classifications within the default classification group.

Show Source

• Array of: object minMaxGroups-GroupClassifications-item-post-request

{
    "title":"Classifications",
    "type":"array",
    "description":"The classifications within the default classification group.",
    "items":{
        "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-item-post-request"
    }
}

Nested Schema : minMaxGroups-GroupClassifications-item-post-request

Type: object

Show Source

• AssociationAvailableFlag: boolean
  Maximum Length: 255

  Value that indicates if the policy profile is used in any of the existing policy assignments.
• ClassCriterias: array Classification Criteria
  Title: Classification Criteria

  Classification criteria used for grouping items.
• ClassificationCode: string
  Maximum Length: 120

  Identifier for the classification.
• ClassificationDesc: string
  Maximum Length: 240

  Description of the classification.
• ClassificationId: integer (int64)
  Value that uniquely identifies the classification.
• ClassificationName: string
  Maximum Length: 120

  Name of the classification.
• CriteriaEntityName: string
  Maximum Length: 255

  Name of the criteria entity
• GroupId: integer (int64)
  Value that uniquely identifies the classification group.
• ObjectVersionNumber: integer (int32)
  Object version number.

{
    "type":"object",
    "properties":{
        "AssociationAvailableFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Value that indicates if the policy profile is used in any of the existing policy assignments.",
            "nullable":true
        },
        "ClassCriterias":{
            "title":"Classification Criteria",
            "type":"array",
            "description":"Classification criteria used for grouping items.",
            "items":{
                "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification.",
            "nullable":true
        },
        "ClassificationDesc":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the classification.",
            "nullable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ClassificationName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the classification.",
            "nullable":true
        },
        "CriteriaEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria entity",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

Nested Schema : Classification Criteria

Type: array

Title: Classification Criteria

Classification criteria used for grouping items.

Show Source

• Array of: object minMaxGroups-GroupClassifications-ClassCriterias-item-post-request

{
    "title":"Classification Criteria",
    "type":"array",
    "description":"Classification criteria used for grouping items.",
    "items":{
        "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : minMaxGroups-GroupClassifications-ClassCriterias-item-post-request

Type: object

Show Source

• ClassificationCode: string
  Maximum Length: 120

  Identifier for the classification.
• ClassificationId(required): integer (int64)
  Value that uniquely identifies the classification.
• CriteriaEntity: string
  Maximum Length: 20

  Identifier for 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.

{
    "required":[
        "ClassificationId"
    ],
    "type":"object",
    "properties":{
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification.",
            "nullable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CriteriaEntity":{
            "maxLength":20,
            "type":"string",
            "description":"Identifier for the criteria entity",
            "nullable":true
        },
        "CriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CriteriaOperator":{
            "maxLength":20,
            "type":"string",
            "description":"Identifier for the criteria operator.",
            "nullable":true
        },
        "CriteriaOperatorString":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria operator.",
            "nullable":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-post-request"
            }
        }
    }
}

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

{
    "title":"Classification Criteria Values",
    "type":"array",
    "description":"Classification criteria values used for grouping items.",
    "items":{
        "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-CriteriaValues-item-post-request"
    }
}

Nested Schema : minMaxGroups-GroupClassifications-ClassCriterias-CriteriaValues-item-post-request

Type: object

Show Source

• CategoryName: string
  Maximum Length: 255

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

  Identifier for the classification.
• 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.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the category.",
            "nullable":true
        },
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification.",
            "nullable":true
        },
        "CriteriaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CriteriaValue":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the criteria value.",
            "nullable":true
        },
        "CriteriaValueId":{
            "type":"integer",
            "description":"Unique identifier of the criteria value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• CatalogId: integer (int64)
  Value that uniquely identifies the catalog.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the classification group.
• Description: string
  Maximum Length: 120

  Description of the classification group.
• GroupClassifications: array Classifications
  Title: Classifications

  The classifications within the default classification group.
• GroupCode: string
  Maximum Length: 120

  Identifier for the classification group.
• GroupId: integer (int64)
  Value that uniquely identifies the classification group.
• GroupName: string
  Maximum Length: 20

  Name of the classification group.
• GrpCatalogName: string
  Maximum Length: 255

  Name of the catalog.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The system login associated with the most recent update of the classification group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the classification group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the classification group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":120,
            "type":"string",
            "description":"Description of the classification group.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupClassifications":{
            "title":"Classifications",
            "type":"array",
            "description":"The classifications within the default classification group.",
            "items":{
                "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-item-response"
            }
        },
        "GroupCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification group.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupName":{
            "maxLength":20,
            "type":"string",
            "description":"Name of the classification group.",
            "nullable":false,
            "x-queryable":true
        },
        "GrpCatalogName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the classification group.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The system login associated with the most recent update of the classification group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the classification group.",
            "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 : Classifications

Type: array

Title: Classifications

The classifications within the default classification group.

Show Source

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

{
    "title":"Classifications",
    "type":"array",
    "description":"The classifications within the default classification group.",
    "items":{
        "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-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-item-response

Type: object

Show Source

• AssociationAvailableFlag: boolean
  Maximum Length: 255

  Value that indicates if the policy profile is used in any of the existing policy assignments.
• ClassCriterias: array Classification Criteria
  Title: Classification Criteria

  Classification criteria used for grouping items.
• ClassificationCode: string
  Maximum Length: 120

  Identifier for the classification.
• ClassificationDesc: string
  Maximum Length: 240

  Description of the classification.
• ClassificationId: integer (int64)
  Value that uniquely identifies the classification.
• ClassificationName: string
  Maximum Length: 120

  Name of the classification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the classification.
• CriteriaEntityName: string
  Maximum Length: 255

  Name of the criteria entity
• CriteriaOperatorString: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the criteria operator.
• CriteriaValuesList: string
  Read Only: true

  Maximum Length: 255

  List of the criteria values.
• GroupId: integer (int64)
  Value that uniquely identifies the classification group.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

  The system login associated with the most recent update of the classification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Object version number.

{
    "type":"object",
    "properties":{
        "AssociationAvailableFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Value that indicates if the policy profile is used in any of the existing policy assignments.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassCriterias":{
            "title":"Classification Criteria",
            "type":"array",
            "description":"Classification criteria used for grouping items.",
            "items":{
                "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-item-response"
            },
            "x-cardinality":"1"
        },
        "ClassificationCode":{
            "maxLength":120,
            "type":"string",
            "description":"Identifier for the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationDesc":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the classification.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the classification.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the criteria entity",
            "nullable":true,
            "x-queryable":true
        },
        "CriteriaOperatorString":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the criteria operator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriteriaValuesList":{
            "maxLength":255,
            "type":"string",
            "description":"List of the criteria values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the classification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The system login associated with the most recent update of the classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number.",
            "format":"int32",
            "nullable":false,
            "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

Type: array

Title: Classification Criteria

Classification criteria used for grouping items.

Show Source

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

{
    "title":"Classification Criteria",
    "type":"array",
    "description":"Classification criteria used for grouping items.",
    "items":{
        "$ref":"#/components/schemas/minMaxGroups-GroupClassifications-ClassCriterias-item-response"
    },
    "x-cardinality":"1"
}

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

GroupClassifications

Operation: /fscmRestApi/resources/11.13.18.05/minMaxGroups/{minMaxGroupsUniqID}/child/GroupClassifications

Parameters:

• minMaxGroupsUniqID: $request.path.minMaxGroupsUniqID

The classifications within the default classification group.

Back to Top