• object Category
  Title: Category

  Discriminator: { "propertyName":"@type", "mapping":{ "Category":"#/components/schemas/Category", "CategoryOracle":"#/components/schemas/CategoryOracle" } }

  The category resource.
• object type

{
    "title":"CategoryOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/Category"
        },
        {
            "type":"object",
            "properties":{
                "project":{
                    "$ref":"#/components/schemas/ProjectRef",
                    "description":"The project associated with the category."
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date and time of the creation."
                },
                "createdBy":{
                    "type":"string",
                    "description":"The name of the person who created item."
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"The name of the person who updated item."
                },
                "externalId":{
                    "type":"string",
                    "description":"The ID of the external associated with the category."
                },
                "applicationName":{
                    "type":"string",
                    "description":"The name of the application associated with the category."
                },
                "versionState":{
                    "type":"number",
                    "description":"The version state of the category."
                }
            }
        }
    ]
}

Discriminator Values

• Category
• CategoryOracle

{
    "title":"Category",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the category."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the category."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the category was last updated."
        },
        "version":{
            "type":"string",
            "description":"The category version."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the category."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the category is valid."
        },
        "isRoot":{
            "type":"boolean",
            "description":"If true, this Boolean indicates that the category is a root of categories."
        },
        "name":{
            "type":"string",
            "description":"The name of the category."
        },
        "description":{
            "type":"string",
            "description":"The description of the category."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the category."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the category."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the category."
        },
        "subCategory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of sub categories associated with the category."
        },
        "parent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of parents associated with the category."
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            },
            "description":"A list of product offerings associated with the category."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Category":"#/components/schemas/Category",
            "CategoryOracle":"#/components/schemas/CategoryOracle"
        }
    },
    "description":"The category resource."
}

• @baseType: string
  The base type of the category.
• @schemaLocation: string
  The URI of the schema that defines the category.
• @type(required): string
  The class type of the category.
• description: string
  The description of the category.
• href: string
  The hyperlink reference to the category.
• id: string
  Maximum Length: 30

  The ID of the category.
• isRoot: boolean
  If true, this Boolean indicates that the category is a root of categories.
• lastUpdate: string (date-time)
  The date and time when the category was last updated.
• lifecycleStatus: string
  The status of the category.
• name(required): string
  The name of the category.
• parent: array parent
  A list of parents associated with the category.
• productOffering: array productOffering
  A list of product offerings associated with the category.
• subCategory: array subCategory
  A list of sub categories associated with the category.
• validFor: object TimePeriod
  Title: TimePeriod

  The period for which the productOffering is valid.
• version: string
  The category version.

{
    "title":"Category",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the category."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the category."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the category was last updated."
        },
        "version":{
            "type":"string",
            "description":"The category version."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the category."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the category is valid."
        },
        "isRoot":{
            "type":"boolean",
            "description":"If true, this Boolean indicates that the category is a root of categories."
        },
        "name":{
            "type":"string",
            "description":"The name of the category."
        },
        "description":{
            "type":"string",
            "description":"The description of the category."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the category."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the category."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the category."
        },
        "subCategory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of sub categories associated with the category."
        },
        "parent":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CategoryRef"
            },
            "description":"A list of parents associated with the category."
        },
        "productOffering":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingRef"
            },
            "description":"A list of product offerings associated with the category."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Category":"#/components/schemas/Category",
            "CategoryOracle":"#/components/schemas/CategoryOracle"
        }
    },
    "description":"The category resource."
}

• applicationName: string
  The name of the application associated with the category.
• created: string (date-time)
  The date and time of the creation.
• createdBy: string
  The name of the person who created item.
• externalId: string
  The ID of the external associated with the category.
• lastUpdatedBy: string
  The name of the person who updated item.
• project: object ProjectRef
  Title: ProjectRef

  The project reference resource.
• versionState: number
  The version state of the category.

{
    "type":"object",
    "properties":{
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The project associated with the category."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created item."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated item."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the category."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the category."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the category."
        }
    }
}

• href: string
  The hyperlink reference to the project reference.
• id(required): string
  The ID of the project reference.
• name: string
  The name of the project reference.
• version: string
  The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

• @schemaLocation: string
  The URI of the schema that defines the error.
• @type: string
  The class type of a REST resource.
• code(required): string
  Application related code (as defined in the API or from a common list).
• message: string
  The text that provides more details and corrective actions related to the error. This can be shown to a client user.
• reason(required): string
  The text that explains the reason for error. This can be shown to a client user.
• referenceError: string
  The URL pointing to documentation describing the error.
• status: string
  The status of the error.

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)."
        },
        "reason":{
            "type":"string",
            "description":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}