GET/v1/operational-catalog-itemsList Operational Catalog Items
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
catalogKey | query | string o nulo | No |
category | query | string o nulo | No |
branchItemId | query | string o nulo | No |
status | query | string o nulo | No |
includeInactive | query | boolean | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de OperationalCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-itemsCreate Operational Catalog Item
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio OperationalCatalogCreateIn
| Campo | Tipo | Obl. |
|---|
catalogKey | string | Sí |
code | string | Sí |
name | string | Sí |
category | string | Sí |
branchItemId | string o nulo | No |
parentItemId | string o nulo | No |
notes | string o nulo | No |
status | string | No |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 201 | Respuesta correcta | OperationalCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/consumerList Operational Catalog Consumer Items
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
catalogKey | query | string | Sí |
branchItemId | query | string o nulo | No |
q | query | string o nulo | No |
limit | query | integer | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de OperationalCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/maintenanceList Operational Catalog Maintenance
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
q | query | string o nulo | No |
catalogKey | query | string o nulo | No |
category | query | string o nulo | No |
branchItemId | query | string o nulo | No |
status | query | string o nulo | No |
includeInactive | query | boolean | No |
page | query | integer | No |
pageSize | query | integer | No |
sortBy | query | string | No |
sortOrder | query | string | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | OperationalCatalogMaintenanceListOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/maintenance/bulk-statusBulk Update Operational Catalog Status
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio OperationalCatalogBulkStatusIn
| Campo | Tipo | Obl. |
|---|
itemIds | lista de string | Sí |
status | string | Sí |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | OperationalCatalogBulkStatusOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/maintenance/exportExport Operational Catalog Maintenance
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
tenant_id | query | string o nulo | No |
Cuerpo obligatorio OperationalCatalogExportIn
| Campo | Tipo | Obl. |
|---|
q | string o nulo | No |
catalogKey | string o nulo | No |
category | string o nulo | No |
branchItemId | string o nulo | No |
status | string o nulo | No |
includeInactive | boolean | No |
sortBy | string | No |
sortOrder | string | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | objeto |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/{item_id}Get Operational Catalog Item
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
item_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | OperationalCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/{item_id}Update Operational Catalog Item
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
item_id | path | string | Sí |
tenant_id | query | string o nulo | No |
Cuerpo obligatorio OperationalCatalogUpdateIn
| Campo | Tipo | Obl. |
|---|
catalogKey | string o nulo | No |
code | string o nulo | No |
name | string o nulo | No |
category | string o nulo | No |
branchItemId | string o nulo | No |
parentItemId | string o nulo | No |
notes | string o nulo | No |
status | string o nulo | No |
auditReason | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | OperationalCatalogItemOut |
| 422 | Error de validación | HTTPValidationError |
/v1/operational-catalog-items/{item_id}/historyList Operational Catalog Item History
Parámetros
| Nombre | En | Tipo | Obl. |
|---|
item_id | path | string | Sí |
limit | query | integer | No |
tenant_id | query | string o nulo | No |
Respuestas
| Código | Descripción | Devuelve |
|---|
| 200 | Respuesta correcta | lista de app__api__routes__operational_catalog__MaintenanceAuditEntryOut |
| 422 | Error de validación | HTTPValidationError |