# Workload properties

Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.

* Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).
* Category - Represents the role or purpose of a workload, such as Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).
* Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).

## List workload categories.

> Retrieves a list of workload categories. These categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platform.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"WorkloadCategories":{"type":"array","items":{"$ref":"#/components/schemas/WorkloadCategory"}},"WorkloadCategory":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"name":{"type":"string","description":"A unique, human-readable name for the workload category."},"description":{"type":"string","description":"An optional description providing additional details about the category."},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the workload category was created."},"createdBy":{"type":"string","description":"The user who created the workload category."}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-categories":{"get":{"summary":"List workload categories.","description":"Retrieves a list of workload categories. These categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platform.","operationId":"list_categories","tags":["Workload properties"],"responses":{"200":{"description":"List of categories retrieved successfully.","content":{"application/json":{"schema":{"type":"object","required":["categories"],"properties":{"categories":{"$ref":"#/components/schemas/WorkloadCategories"}}}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Get workload category by id.

> Retrieves a specific workload category by its ID. Workload categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platform.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"WorkloadCategory":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"name":{"type":"string","description":"A unique, human-readable name for the workload category."},"description":{"type":"string","description":"An optional description providing additional details about the category."},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the workload category was created."},"createdBy":{"type":"string","description":"The user who created the workload category."}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-categories/{categoryId}":{"get":{"summary":"Get workload category by id.","description":"Retrieves a specific workload category by its ID. Workload categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platform.","operationId":"get_category_by_id","tags":["Workload properties"],"parameters":[{"name":"categoryId","description":"The unique identifier of the workload category.","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Category retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadCategory"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## List workload types.

> Retrieves a list of workload types with their configurations - their corresponding workload categories and priorities.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"ExternalTypesOnly":{"name":"externalTypesOnly","in":"query","required":false,"description":"Return only external and user_external sourced workload types.","schema":{"type":"boolean","default":false}},"WorkloadTypesFilter":{"name":"filterBy","in":"query","required":false,"description":"Filter results by a parameter. Use the format field-name operator value. Operators are `==` Equals, `!=` Not equals, `<=` Less than or equal, `>=` Greater than or equal, `=@` contains, `!@` Does not contain, `=^` Starts with and `=$` Ends with. Dates are in ISO 8601 timestamp format and available for operators `==`, `!=`, `<=` and `>=`.","schema":{"type":"array","items":{"type":"string","pattern":"^(name|group)(==|!=|<=|>=|=@|!@|=\\^|=\\$).+$"}},"explode":false}},"schemas":{"WorkloadTypeConfigs":{"type":"array","items":{"$ref":"#/components/schemas/WorkloadTypeConfig"}},"WorkloadTypeConfig":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeAdditionalResponseFields"},{"$ref":"#/components/schemas/WorkloadTypeAdditionalCreateFields"},{"type":"object","required":["name","group","categoryId","priorityId","preemptibility"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workload type."},"categoryName":{"type":"string","description":"The name of the workload category."},"priorityName":{"type":"string","description":"The name of the workload priority."},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp for the last time the workload type was updated."},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the workload type."},"createdAt":{"type":"string","format":"date-time","description":"The timestamp for when the workload type was created."},"createdBy":{"type":"string","description":"Identifier of the user who created the workload type."},"resourceInterfaces":{"$ref":"#/components/schemas/WorkloadTypeResourceInterfacesWithVersion"},"clusterStatuses":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/WorkloadTypeStatus"}}}}]},"WorkloadTypeAdditionalResponseFields":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"priorityId":{"type":"string","format":"uuid","description":"The unique identifier of the workload priority."},"preemptibility":{"$ref":"#/components/schemas/WorkloadTypePreemptibility"}}},"WorkloadTypePreemptibility":{"type":"string","description":"Indicates the default preemptibility level of the workload type. Only available for workloads submitted to clusters of versions 2.24+. The default, if not specified, is if priority.value >= 100 - then 'non-preemptible', else 'preemptible'.","enum":["preemptible","non-preemptible"]},"WorkloadTypeAdditionalCreateFields":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the workload type. This value must exactly match the Kubernetes Kind that represents the workload type.","pattern":"^[A-Z][a-z0-9]*([A-Z][a-z0-9]*)*$"},"group":{"type":"string","description":"The Kubernetes group associated with the workload resource.","pattern":"^[a-z](?:[a-z0-9.-]*[a-z0-9])?$"}}},"WorkloadTypeResourceInterfacesWithVersion":{"type":"array","description":"Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version.","items":{"type":"object","properties":{"version":{"type":"string","description":"The version of the resource definition k8s crd."},"resourceInterface":{"$ref":"#/components/schemas/WorkloadTypeResourceInterface"}}}},"WorkloadTypeResourceInterface":{"type":"object","description":"The resource interface for the workload type.","additionalProperties":true},"WorkloadTypeStatus":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeStatusFields"},{"type":"object","properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the workload type status of this cluster was last updated."}}}]},"WorkloadTypeStatusFields":{"type":"object","properties":{"phase":{"type":"string","description":"The current phase of the workload type in the cluster."},"conditions":{"$ref":"#/components/schemas/Conditions"},"version":{"type":"string","description":"The version of the resource definition's Kubernetes CRD."}}},"Conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition1"}},"Condition1":{"type":"object","required":["type","status"],"properties":{"type":{"description":"The type of the condition, such as Failed or Available. See Types of domain status conditions.","type":"string"},"status":{"type":"string","description":"The status of the condition, such as True, False or Unknown."},"message":{"type":"string","description":"An optional, human-readable message providing more details about the condition."},"reason":{"type":"string","description":"The reason for the Failed condition. Not applicable to other types of condition."},"lastTransitionTime":{"description":"A timestamp of when the condition was created or the last time the condition transitioned from one status to another.","type":"string","nullable":true,"format":"date-time"}}},"ClusterId":{"description":"The id of the cluster.","type":"string","format":"uuid"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-types":{"get":{"summary":"List workload types.","description":"Retrieves a list of workload types with their configurations - their corresponding workload categories and priorities.","operationId":"list_workload_types","tags":["Workload properties"],"parameters":[{"$ref":"#/components/parameters/ExternalTypesOnly"},{"$ref":"#/components/parameters/WorkloadTypesFilter"}],"responses":{"200":{"description":"List of types retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["types"],"properties":{"types":{"$ref":"#/components/schemas/WorkloadTypeConfigs"}}}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Create a workload type. \[Experimental]

> Create a new workload type in the system by providing its identification details and configuration, making it available for use and management within the platform.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"WorkloadTypeCreateFields":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeCreateUpdateInnerFields"},{"$ref":"#/components/schemas/WorkloadTypeAdditionalCreateFields"},{"type":"object","required":["name","group","categoryId","priorityId"],"properties":{"resourceInterfaces":{"$ref":"#/components/schemas/WorkloadTypeResourceInterfaces"}}}]},"WorkloadTypeCreateUpdateInnerFields":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"priorityId":{"type":"string","format":"uuid","description":"The unique identifier of the workload priority."},"preemptibility":{"type":"string","nullable":true,"allOf":[{"$ref":"#/components/schemas/WorkloadTypePreemptibility"}]}}},"WorkloadTypePreemptibility":{"type":"string","description":"Indicates the default preemptibility level of the workload type. Only available for workloads submitted to clusters of versions 2.24+. The default, if not specified, is if priority.value >= 100 - then 'non-preemptible', else 'preemptible'.","enum":["preemptible","non-preemptible"]},"WorkloadTypeAdditionalCreateFields":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the workload type. This value must exactly match the Kubernetes Kind that represents the workload type.","pattern":"^[A-Z][a-z0-9]*([A-Z][a-z0-9]*)*$"},"group":{"type":"string","description":"The Kubernetes group associated with the workload resource.","pattern":"^[a-z](?:[a-z0-9.-]*[a-z0-9])?$"}}},"WorkloadTypeResourceInterfaces":{"type":"array","description":"Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version. On update, you may only add or remove supported versions, modifying existing version entries is not allowed.","maxItems":4,"items":{"$ref":"#/components/schemas/WorkloadTypeResourceInterface"}},"WorkloadTypeResourceInterface":{"type":"object","description":"The resource interface for the workload type.","additionalProperties":true},"WorkloadTypeConfig":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeAdditionalResponseFields"},{"$ref":"#/components/schemas/WorkloadTypeAdditionalCreateFields"},{"type":"object","required":["name","group","categoryId","priorityId","preemptibility"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workload type."},"categoryName":{"type":"string","description":"The name of the workload category."},"priorityName":{"type":"string","description":"The name of the workload priority."},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp for the last time the workload type was updated."},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the workload type."},"createdAt":{"type":"string","format":"date-time","description":"The timestamp for when the workload type was created."},"createdBy":{"type":"string","description":"Identifier of the user who created the workload type."},"resourceInterfaces":{"$ref":"#/components/schemas/WorkloadTypeResourceInterfacesWithVersion"},"clusterStatuses":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/WorkloadTypeStatus"}}}}]},"WorkloadTypeAdditionalResponseFields":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"priorityId":{"type":"string","format":"uuid","description":"The unique identifier of the workload priority."},"preemptibility":{"$ref":"#/components/schemas/WorkloadTypePreemptibility"}}},"WorkloadTypeResourceInterfacesWithVersion":{"type":"array","description":"Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version.","items":{"type":"object","properties":{"version":{"type":"string","description":"The version of the resource definition k8s crd."},"resourceInterface":{"$ref":"#/components/schemas/WorkloadTypeResourceInterface"}}}},"WorkloadTypeStatus":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeStatusFields"},{"type":"object","properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the workload type status of this cluster was last updated."}}}]},"WorkloadTypeStatusFields":{"type":"object","properties":{"phase":{"type":"string","description":"The current phase of the workload type in the cluster."},"conditions":{"$ref":"#/components/schemas/Conditions"},"version":{"type":"string","description":"The version of the resource definition's Kubernetes CRD."}}},"Conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition1"}},"Condition1":{"type":"object","required":["type","status"],"properties":{"type":{"description":"The type of the condition, such as Failed or Available. See Types of domain status conditions.","type":"string"},"status":{"type":"string","description":"The status of the condition, such as True, False or Unknown."},"message":{"type":"string","description":"An optional, human-readable message providing more details about the condition."},"reason":{"type":"string","description":"The reason for the Failed condition. Not applicable to other types of condition."},"lastTransitionTime":{"description":"A timestamp of when the condition was created or the last time the condition transitioned from one status to another.","type":"string","nullable":true,"format":"date-time"}}},"ClusterId":{"description":"The id of the cluster.","type":"string","format":"uuid"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409Conflict":{"description":"The specified resource already exists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-types":{"post":{"summary":"Create a workload type. [Experimental]","description":"Create a new workload type in the system by providing its identification details and configuration, making it available for use and management within the platform.","operationId":"create_workload_type","tags":["Workload properties"],"requestBody":{"description":"Workload type to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadTypeCreateFields"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadTypeConfig"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"409":{"$ref":"#/components/responses/409Conflict"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## List workload type by id.

> Retrieves a specific workload type by its ID.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"WorkloadTypeId":{"name":"workloadTypeId","in":"path","required":true,"description":"The unique identifier of the workload type.","schema":{"type":"string","format":"uuid"}}},"schemas":{"WorkloadTypeConfig":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeAdditionalResponseFields"},{"$ref":"#/components/schemas/WorkloadTypeAdditionalCreateFields"},{"type":"object","required":["name","group","categoryId","priorityId","preemptibility"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workload type."},"categoryName":{"type":"string","description":"The name of the workload category."},"priorityName":{"type":"string","description":"The name of the workload priority."},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp for the last time the workload type was updated."},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the workload type."},"createdAt":{"type":"string","format":"date-time","description":"The timestamp for when the workload type was created."},"createdBy":{"type":"string","description":"Identifier of the user who created the workload type."},"resourceInterfaces":{"$ref":"#/components/schemas/WorkloadTypeResourceInterfacesWithVersion"},"clusterStatuses":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/WorkloadTypeStatus"}}}}]},"WorkloadTypeAdditionalResponseFields":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"priorityId":{"type":"string","format":"uuid","description":"The unique identifier of the workload priority."},"preemptibility":{"$ref":"#/components/schemas/WorkloadTypePreemptibility"}}},"WorkloadTypePreemptibility":{"type":"string","description":"Indicates the default preemptibility level of the workload type. Only available for workloads submitted to clusters of versions 2.24+. The default, if not specified, is if priority.value >= 100 - then 'non-preemptible', else 'preemptible'.","enum":["preemptible","non-preemptible"]},"WorkloadTypeAdditionalCreateFields":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the workload type. This value must exactly match the Kubernetes Kind that represents the workload type.","pattern":"^[A-Z][a-z0-9]*([A-Z][a-z0-9]*)*$"},"group":{"type":"string","description":"The Kubernetes group associated with the workload resource.","pattern":"^[a-z](?:[a-z0-9.-]*[a-z0-9])?$"}}},"WorkloadTypeResourceInterfacesWithVersion":{"type":"array","description":"Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version.","items":{"type":"object","properties":{"version":{"type":"string","description":"The version of the resource definition k8s crd."},"resourceInterface":{"$ref":"#/components/schemas/WorkloadTypeResourceInterface"}}}},"WorkloadTypeResourceInterface":{"type":"object","description":"The resource interface for the workload type.","additionalProperties":true},"WorkloadTypeStatus":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeStatusFields"},{"type":"object","properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the workload type status of this cluster was last updated."}}}]},"WorkloadTypeStatusFields":{"type":"object","properties":{"phase":{"type":"string","description":"The current phase of the workload type in the cluster."},"conditions":{"$ref":"#/components/schemas/Conditions"},"version":{"type":"string","description":"The version of the resource definition's Kubernetes CRD."}}},"Conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition1"}},"Condition1":{"type":"object","required":["type","status"],"properties":{"type":{"description":"The type of the condition, such as Failed or Available. See Types of domain status conditions.","type":"string"},"status":{"type":"string","description":"The status of the condition, such as True, False or Unknown."},"message":{"type":"string","description":"An optional, human-readable message providing more details about the condition."},"reason":{"type":"string","description":"The reason for the Failed condition. Not applicable to other types of condition."},"lastTransitionTime":{"description":"A timestamp of when the condition was created or the last time the condition transitioned from one status to another.","type":"string","nullable":true,"format":"date-time"}}},"ClusterId":{"description":"The id of the cluster.","type":"string","format":"uuid"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-types/{workloadTypeId}":{"get":{"summary":"List workload type by id.","description":"Retrieves a specific workload type by its ID.","operationId":"get_workload_type","tags":["Workload properties"],"parameters":[{"$ref":"#/components/parameters/WorkloadTypeId"}],"responses":{"200":{"description":"Type retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadTypeConfig"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Update a workload type by id.

> Update the default category or priority assigned to a workload type.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"WorkloadTypeId":{"name":"workloadTypeId","in":"path","required":true,"description":"The unique identifier of the workload type.","schema":{"type":"string","format":"uuid"}}},"schemas":{"WorkloadTypeUpdateFields":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeCreateUpdateInnerFields"},{"type":"object","properties":{"resourceInterfaces":{"$ref":"#/components/schemas/WorkloadTypeResourceInterfacesNullable"}}}]},"WorkloadTypeCreateUpdateInnerFields":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"priorityId":{"type":"string","format":"uuid","description":"The unique identifier of the workload priority."},"preemptibility":{"type":"string","nullable":true,"allOf":[{"$ref":"#/components/schemas/WorkloadTypePreemptibility"}]}}},"WorkloadTypePreemptibility":{"type":"string","description":"Indicates the default preemptibility level of the workload type. Only available for workloads submitted to clusters of versions 2.24+. The default, if not specified, is if priority.value >= 100 - then 'non-preemptible', else 'preemptible'.","enum":["preemptible","non-preemptible"]},"WorkloadTypeResourceInterfacesNullable":{"type":"array","nullable":true,"description":"Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version. On update, you may only add or remove supported versions, modifying existing version entries is not allowed.","maxItems":4,"items":{"$ref":"#/components/schemas/WorkloadTypeResourceInterface"}},"WorkloadTypeResourceInterface":{"type":"object","description":"The resource interface for the workload type.","additionalProperties":true},"WorkloadTypeConfig":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeAdditionalResponseFields"},{"$ref":"#/components/schemas/WorkloadTypeAdditionalCreateFields"},{"type":"object","required":["name","group","categoryId","priorityId","preemptibility"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the workload type."},"categoryName":{"type":"string","description":"The name of the workload category."},"priorityName":{"type":"string","description":"The name of the workload priority."},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp for the last time the workload type was updated."},"updatedBy":{"type":"string","description":"Identifier of the user who last updated the workload type."},"createdAt":{"type":"string","format":"date-time","description":"The timestamp for when the workload type was created."},"createdBy":{"type":"string","description":"Identifier of the user who created the workload type."},"resourceInterfaces":{"$ref":"#/components/schemas/WorkloadTypeResourceInterfacesWithVersion"},"clusterStatuses":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/WorkloadTypeStatus"}}}}]},"WorkloadTypeAdditionalResponseFields":{"type":"object","properties":{"categoryId":{"type":"string","format":"uuid","description":"The unique identifier of the workload category."},"priorityId":{"type":"string","format":"uuid","description":"The unique identifier of the workload priority."},"preemptibility":{"$ref":"#/components/schemas/WorkloadTypePreemptibility"}}},"WorkloadTypeAdditionalCreateFields":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of the workload type. This value must exactly match the Kubernetes Kind that represents the workload type.","pattern":"^[A-Z][a-z0-9]*([A-Z][a-z0-9]*)*$"},"group":{"type":"string","description":"The Kubernetes group associated with the workload resource.","pattern":"^[a-z](?:[a-z0-9.-]*[a-z0-9])?$"}}},"WorkloadTypeResourceInterfacesWithVersion":{"type":"array","description":"Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version.","items":{"type":"object","properties":{"version":{"type":"string","description":"The version of the resource definition k8s crd."},"resourceInterface":{"$ref":"#/components/schemas/WorkloadTypeResourceInterface"}}}},"WorkloadTypeStatus":{"allOf":[{"$ref":"#/components/schemas/WorkloadTypeStatusFields"},{"type":"object","properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId"},"updatedAt":{"type":"string","format":"date-time","description":"The date and time when the workload type status of this cluster was last updated."}}}]},"WorkloadTypeStatusFields":{"type":"object","properties":{"phase":{"type":"string","description":"The current phase of the workload type in the cluster."},"conditions":{"$ref":"#/components/schemas/Conditions"},"version":{"type":"string","description":"The version of the resource definition's Kubernetes CRD."}}},"Conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition1"}},"Condition1":{"type":"object","required":["type","status"],"properties":{"type":{"description":"The type of the condition, such as Failed or Available. See Types of domain status conditions.","type":"string"},"status":{"type":"string","description":"The status of the condition, such as True, False or Unknown."},"message":{"type":"string","description":"An optional, human-readable message providing more details about the condition."},"reason":{"type":"string","description":"The reason for the Failed condition. Not applicable to other types of condition."},"lastTransitionTime":{"description":"A timestamp of when the condition was created or the last time the condition transitioned from one status to another.","type":"string","nullable":true,"format":"date-time"}}},"ClusterId":{"description":"The id of the cluster.","type":"string","format":"uuid"},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-types/{workloadTypeId}":{"put":{"summary":"Update a workload type by id.","description":"Update the default category or priority assigned to a workload type.","operationId":"update_workload_type","tags":["Workload properties"],"parameters":[{"$ref":"#/components/parameters/WorkloadTypeId"}],"requestBody":{"description":"Workload type to update.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadTypeUpdateFields"}}}},"responses":{"200":{"description":"Updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadTypeConfig"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Delete a workload type by id. \[Experimental]

> Deletes a specific workload type by its ID.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"WorkloadTypeId":{"name":"workloadTypeId","in":"path","required":true,"description":"The unique identifier of the workload type.","schema":{"type":"string","format":"uuid"}}},"responses":{"204NoContent":{"description":"No Content."},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}}},"paths":{"/api/v1/workload-types/{workloadTypeId}":{"delete":{"summary":"Delete a workload type by id. [Experimental]","description":"Deletes a specific workload type by its ID.","operationId":"delete_workload_type","tags":["Workload properties"],"parameters":[{"$ref":"#/components/parameters/WorkloadTypeId"}],"responses":{"204":{"$ref":"#/components/responses/204NoContent"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Get workload priorities.

> Retrieve the list of all workload priorities available in the system

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.24"},"tags":[{"name":"Workload properties","description":"Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.\n- Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).\n- Category - Represents the role or purpose of a workload, such as  Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See [Monitor workloads by category](https://run-ai-docs.nvidia.com/saas/platform-management/monitor-performance/workload-categories).\n- Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See [Workload priority control](https://run-ai-docs.nvidia.com/saas/platform-management/runai-scheduler/scheduling/workload-priority-control).\n"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"SortOrder":{"name":"sortOrder","in":"query","required":false,"description":"Sort results in descending or ascending order.","schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},"WorkloadsPrioritiesSort":{"name":"sortBy","description":"Defines the field to sort the results by","in":"query","required":false,"schema":{"type":"string","enum":["name","source","value"]}},"WorkloadsPrioritiesFilter":{"name":"filterBy","description":"Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","pattern":"^(name|source|value)(==|!=|<=|>=|=@|!@|=\\^|=\\$).+$"}},"explode":false}},"schemas":{"Priorities":{"type":"array","items":{"$ref":"#/components/schemas/WorkloadPriority"}},"WorkloadPriority":{"allOf":[{"type":"object"},{"properties":{"aggregatedPhase":{"type":"string","description":"Combined status of the priority across all clusters"},"status":{"type":"array","description":"Per-cluster status details","items":{"$ref":"#/components/schemas/PriorityStatus"}},"scopeType":{"description":"The type of scope the workload priority applies to.","type":"string"},"scopeId":{"description":"The unique identifier of the scope the workload priority applies to.","type":"string"}}},{"$ref":"#/components/schemas/BasePriority"}]},"PriorityStatus":{"type":"object","properties":{"clusterId":{"type":"string","description":"The unique identifier of the cluster"},"phase":{"type":"string","description":"Current phase of the priority in the specified cluster"}}},"BasePriority":{"type":"object","required":["id","name","value"],"properties":{"id":{"type":"string","description":"The unique identifier of the workload priority"},"source":{"description":"The source of the priority class. Indicates where the priority definition originated. Currently, the value is either Run:ai or empty.","type":"string"},"name":{"type":"string","description":"The name of the workload priority (e.g., low, medium, high)"},"value":{"type":"integer","minimum":0,"description":"The scheduling value assigned to this priority"},"createdAt":{"type":"string","format":"date-time","description":"The timestamp for when the priority was created"},"updatedAt":{"type":"string","format":"date-time","description":"The timestamp for when the priority was updated"}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/workload-priorities":{"get":{"summary":"Get workload priorities.","description":"Retrieve the list of all workload priorities available in the system","operationId":"get_workload_priorities","tags":["Workload properties"],"parameters":[{"$ref":"#/components/parameters/SortOrder"},{"$ref":"#/components/parameters/WorkloadsPrioritiesSort"},{"$ref":"#/components/parameters/WorkloadsPrioritiesFilter"}],"responses":{"200":{"description":"Request completed successfully.","content":{"application/json":{"schema":{"type":"object","required":["priorities"],"properties":{"priorities":{"$ref":"#/components/schemas/Priorities"}}}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```