{ "swagger": "2.0", "info": { "title": "Entity Catalog Management", "description": "## TMF API Reference: TMF662 - Entity Catalog Management\n\n### Release : V4.0 - Mar 2020\n\nEntity Catalog API is one of Catalog Management API Family. Entity Catalog API goal is to provide a catalog of arbitrary entities, so that there will be no need for specific catalogs in addition to product, service, and resource. \n\n### Operations\nEntity Catalog API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity\n- Manage notification of events", "version": "4.0.0" }, "host": "serverRoot", "basePath": "/tmf-api/entityCatalogManagement/v4/", "schemes": [ "https" ], "consumes": [ "application/json;charset=utf-8" ], "produces": [ "application/json;charset=utf-8" ], "tags": [ { "name": "entityCatalog" }, { "name": "entityCategory" }, { "name": "entityCatalogItem" }, { "name": "entitySpecification" }, { "name": "associationSpecification" }, { "name": "association" }, { "name": "importJob" }, { "name": "exportJob" }, { "name": "notification listeners (client side)" }, { "name": "events subscription" } ], "paths": { "/entityCatalog": { "get": { "operationId": "listEntityCatalog", "summary": "List or find EntityCatalog objects", "description": "This operation list or find EntityCatalog entities", "tags": [ "entityCatalog" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/EntityCatalog" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createEntityCatalog", "summary": "Creates a EntityCatalog", "description": "This operation creates a EntityCatalog entity.", "tags": [ "entityCatalog" ], "parameters": [ { "name": "entityCatalog", "description": "The EntityCatalog to be created", "required": true, "schema": { "$ref": "#/definitions/EntityCatalog_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/EntityCatalog" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entityCatalog/{id}": { "get": { "operationId": "retrieveEntityCatalog", "summary": "Retrieves a EntityCatalog by ID", "description": "This operation retrieves a EntityCatalog entity. Attribute selection is enabled for all first level attributes.", "tags": [ "entityCatalog" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCatalog", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EntityCatalog" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "operationId": "patchEntityCatalog", "summary": "Updates partially a EntityCatalog", "description": "This operation updates partially a EntityCatalog entity.", "tags": [ "entityCatalog" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCatalog", "required": true, "type": "string", "in": "path" }, { "name": "entityCatalog", "description": "The EntityCatalog to be updated", "required": true, "schema": { "$ref": "#/definitions/EntityCatalog_Update" }, "in": "body" } ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/EntityCatalog" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteEntityCatalog", "summary": "Deletes a EntityCatalog", "description": "This operation deletes a EntityCatalog entity.", "tags": [ "entityCatalog" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCatalog", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entityCategory": { "get": { "operationId": "listEntityCategory", "summary": "List or find EntityCategory objects", "description": "This operation list or find EntityCategory entities", "tags": [ "entityCategory" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/EntityCategory" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createEntityCategory", "summary": "Creates a EntityCategory", "description": "This operation creates a EntityCategory entity.", "tags": [ "entityCategory" ], "parameters": [ { "name": "entityCategory", "description": "The EntityCategory to be created", "required": true, "schema": { "$ref": "#/definitions/EntityCategory_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/EntityCategory" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entityCategory/{id}": { "get": { "operationId": "retrieveEntityCategory", "summary": "Retrieves a EntityCategory by ID", "description": "This operation retrieves a EntityCategory entity. Attribute selection is enabled for all first level attributes.", "tags": [ "entityCategory" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCategory", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EntityCategory" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "operationId": "patchEntityCategory", "summary": "Updates partially a EntityCategory", "description": "This operation updates partially a EntityCategory entity.", "tags": [ "entityCategory" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCategory", "required": true, "type": "string", "in": "path" }, { "name": "entityCategory", "description": "The EntityCategory to be updated", "required": true, "schema": { "$ref": "#/definitions/EntityCategory_Update" }, "in": "body" } ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/EntityCategory" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteEntityCategory", "summary": "Deletes a EntityCategory", "description": "This operation deletes a EntityCategory entity.", "tags": [ "entityCategory" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCategory", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entityCatalogItem": { "get": { "operationId": "listEntityCatalogItem", "summary": "List or find EntityCatalogItem objects", "description": "This operation list or find EntityCatalogItem entities", "tags": [ "entityCatalogItem" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/EntityCatalogItem" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createEntityCatalogItem", "summary": "Creates a EntityCatalogItem", "description": "This operation creates a EntityCatalogItem entity.", "tags": [ "entityCatalogItem" ], "parameters": [ { "name": "entityCatalogItem", "description": "The EntityCatalogItem to be created", "required": true, "schema": { "$ref": "#/definitions/EntityCatalogItem_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/EntityCatalogItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entityCatalogItem/{id}": { "get": { "operationId": "retrieveEntityCatalogItem", "summary": "Retrieves a EntityCatalogItem by ID", "description": "This operation retrieves a EntityCatalogItem entity. Attribute selection is enabled for all first level attributes.", "tags": [ "entityCatalogItem" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCatalogItem", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EntityCatalogItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "operationId": "patchEntityCatalogItem", "summary": "Updates partially a EntityCatalogItem", "description": "This operation updates partially a EntityCatalogItem entity.", "tags": [ "entityCatalogItem" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCatalogItem", "required": true, "type": "string", "in": "path" }, { "name": "entityCatalogItem", "description": "The EntityCatalogItem to be updated", "required": true, "schema": { "$ref": "#/definitions/EntityCatalogItem_Update" }, "in": "body" } ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/EntityCatalogItem" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteEntityCatalogItem", "summary": "Deletes a EntityCatalogItem", "description": "This operation deletes a EntityCatalogItem entity.", "tags": [ "entityCatalogItem" ], "parameters": [ { "name": "id", "description": "Identifier of the EntityCatalogItem", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entitySpecification": { "get": { "operationId": "listEntitySpecification", "summary": "List or find EntitySpecification objects", "description": "This operation list or find EntitySpecification entities", "tags": [ "entitySpecification" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/EntitySpecification" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createEntitySpecification", "summary": "Creates a EntitySpecification", "description": "This operation creates a EntitySpecification entity.", "tags": [ "entitySpecification" ], "parameters": [ { "name": "entitySpecification", "description": "The EntitySpecification to be created", "required": true, "schema": { "$ref": "#/definitions/EntitySpecification_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/EntitySpecification" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/entitySpecification/{id}": { "get": { "operationId": "retrieveEntitySpecification", "summary": "Retrieves a EntitySpecification by ID", "description": "This operation retrieves a EntitySpecification entity. Attribute selection is enabled for all first level attributes.", "tags": [ "entitySpecification" ], "parameters": [ { "name": "id", "description": "Identifier of the EntitySpecification", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/EntitySpecification" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "operationId": "patchEntitySpecification", "summary": "Updates partially a EntitySpecification", "description": "This operation updates partially a EntitySpecification entity.", "tags": [ "entitySpecification" ], "parameters": [ { "name": "id", "description": "Identifier of the EntitySpecification", "required": true, "type": "string", "in": "path" }, { "name": "entitySpecification", "description": "The EntitySpecification to be updated", "required": true, "schema": { "$ref": "#/definitions/EntitySpecification_Update" }, "in": "body" } ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/EntitySpecification" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteEntitySpecification", "summary": "Deletes a EntitySpecification", "description": "This operation deletes a EntitySpecification entity.", "tags": [ "entitySpecification" ], "parameters": [ { "name": "id", "description": "Identifier of the EntitySpecification", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/associationSpecification": { "get": { "operationId": "listAssociationSpecification", "summary": "List or find AssociationSpecification objects", "description": "This operation list or find AssociationSpecification entities", "tags": [ "associationSpecification" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/AssociationSpecification" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createAssociationSpecification", "summary": "Creates a AssociationSpecification", "description": "This operation creates a AssociationSpecification entity.", "tags": [ "associationSpecification" ], "parameters": [ { "name": "associationSpecification", "description": "The AssociationSpecification to be created", "required": true, "schema": { "$ref": "#/definitions/AssociationSpecification_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/AssociationSpecification" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/associationSpecification/{id}": { "get": { "operationId": "retrieveAssociationSpecification", "summary": "Retrieves a AssociationSpecification by ID", "description": "This operation retrieves a AssociationSpecification entity. Attribute selection is enabled for all first level attributes.", "tags": [ "associationSpecification" ], "parameters": [ { "name": "id", "description": "Identifier of the AssociationSpecification", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AssociationSpecification" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "operationId": "patchAssociationSpecification", "summary": "Updates partially a AssociationSpecification", "description": "This operation updates partially a AssociationSpecification entity.", "tags": [ "associationSpecification" ], "parameters": [ { "name": "id", "description": "Identifier of the AssociationSpecification", "required": true, "type": "string", "in": "path" }, { "name": "associationSpecification", "description": "The AssociationSpecification to be updated", "required": true, "schema": { "$ref": "#/definitions/AssociationSpecification_Update" }, "in": "body" } ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/AssociationSpecification" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteAssociationSpecification", "summary": "Deletes a AssociationSpecification", "description": "This operation deletes a AssociationSpecification entity.", "tags": [ "associationSpecification" ], "parameters": [ { "name": "id", "description": "Identifier of the AssociationSpecification", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/association": { "get": { "operationId": "listAssociation", "summary": "List or find Association objects", "description": "This operation list or find Association entities", "tags": [ "association" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/Association" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createAssociation", "summary": "Creates a Association", "description": "This operation creates a Association entity.", "tags": [ "association" ], "parameters": [ { "name": "association", "description": "The Association to be created", "required": true, "schema": { "$ref": "#/definitions/Association_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/Association" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/association/{id}": { "get": { "operationId": "retrieveAssociation", "summary": "Retrieves a Association by ID", "description": "This operation retrieves a Association entity. Attribute selection is enabled for all first level attributes.", "tags": [ "association" ], "parameters": [ { "name": "id", "description": "Identifier of the Association", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Association" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "patch": { "operationId": "patchAssociation", "summary": "Updates partially a Association", "description": "This operation updates partially a Association entity.", "tags": [ "association" ], "parameters": [ { "name": "id", "description": "Identifier of the Association", "required": true, "type": "string", "in": "path" }, { "name": "association", "description": "The Association to be updated", "required": true, "schema": { "$ref": "#/definitions/Association_Update" }, "in": "body" } ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/Association" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteAssociation", "summary": "Deletes a Association", "description": "This operation deletes a Association entity.", "tags": [ "association" ], "parameters": [ { "name": "id", "description": "Identifier of the Association", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/importJob": { "get": { "operationId": "listImportJob", "summary": "List or find ImportJob objects", "description": "This operation list or find ImportJob entities", "tags": [ "importJob" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ImportJob" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createImportJob", "summary": "Creates a ImportJob", "description": "This operation creates a ImportJob entity.", "tags": [ "importJob" ], "parameters": [ { "name": "importJob", "description": "The ImportJob to be created", "required": true, "schema": { "$ref": "#/definitions/ImportJob_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ImportJob" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/importJob/{id}": { "get": { "operationId": "retrieveImportJob", "summary": "Retrieves a ImportJob by ID", "description": "This operation retrieves a ImportJob entity. Attribute selection is enabled for all first level attributes.", "tags": [ "importJob" ], "parameters": [ { "name": "id", "description": "Identifier of the ImportJob", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ImportJob" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteImportJob", "summary": "Deletes a ImportJob", "description": "This operation deletes a ImportJob entity.", "tags": [ "importJob" ], "parameters": [ { "name": "id", "description": "Identifier of the ImportJob", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/exportJob": { "get": { "operationId": "listExportJob", "summary": "List or find ExportJob objects", "description": "This operation list or find ExportJob entities", "tags": [ "exportJob" ], "parameters": [ { "name": "fields", "description": "Comma-separated properties to be provided in response", "required": false, "in": "query", "type": "string" }, { "name": "offset", "description": "Requested index for start of resources to be provided in response", "required": false, "in": "query", "type": "integer" }, { "name": "limit", "description": "Requested number of resources to be provided in response", "required": false, "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Success", "headers": { "X-Result-Count": { "description": "Actual number of items returned in the response body", "type": "integer" }, "X-Total-Count": { "description": "Total number of items matching criteria", "type": "integer" } }, "schema": { "type": "array", "items": { "$ref": "#/definitions/ExportJob" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "operationId": "createExportJob", "summary": "Creates a ExportJob", "description": "This operation creates a ExportJob entity.", "tags": [ "exportJob" ], "parameters": [ { "name": "exportJob", "description": "The ExportJob to be created", "required": true, "schema": { "$ref": "#/definitions/ExportJob_Create" }, "in": "body" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ExportJob" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/exportJob/{id}": { "get": { "operationId": "retrieveExportJob", "summary": "Retrieves a ExportJob by ID", "description": "This operation retrieves a ExportJob entity. Attribute selection is enabled for all first level attributes.", "tags": [ "exportJob" ], "parameters": [ { "name": "id", "description": "Identifier of the ExportJob", "required": true, "type": "string", "in": "path" }, { "name": "fields", "description": "Comma-separated properties to provide in response", "required": false, "type": "string", "in": "query" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ExportJob" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "operationId": "deleteExportJob", "summary": "Deletes a ExportJob", "description": "This operation deletes a ExportJob entity.", "tags": [ "exportJob" ], "parameters": [ { "name": "id", "description": "Identifier of the ExportJob", "required": true, "type": "string", "in": "path" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/hub": { "post": { "operationId": "registerListener", "summary": "Register a listener", "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "tags": [ "events subscription" ], "parameters": [ { "name": "data", "schema": { "$ref": "#/definitions/EventSubscriptionInput" }, "required": true, "in": "body", "description": "Data containing the callback endpoint to deliver the information" } ], "responses": { "201": { "description": "Subscribed", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/hub/{id}": { "delete": { "operationId": "unregisterListener", "summary": "Unregister a listener", "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.", "tags": [ "events subscription" ], "parameters": [ { "name": "id", "type": "string", "required": true, "in": "path", "description": "The id of the registered listener" } ], "responses": { "204": { "description": "Deleted" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method not allowed", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogCreateEvent": { "post": { "operationId": "listenToEntityCatalogCreateEvent", "summary": "Client listener for entity EntityCatalogCreateEvent", "description": "Example of a client listener for receiving the notification EntityCatalogCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogAttributeValueChangeEvent": { "post": { "operationId": "listenToEntityCatalogAttributeValueChangeEvent", "summary": "Client listener for entity EntityCatalogAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification EntityCatalogAttributeValueChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogAttributeValueChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogStateChangeEvent": { "post": { "operationId": "listenToEntityCatalogStateChangeEvent", "summary": "Client listener for entity EntityCatalogStateChangeEvent", "description": "Example of a client listener for receiving the notification EntityCatalogStateChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogStateChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogDeleteEvent": { "post": { "operationId": "listenToEntityCatalogDeleteEvent", "summary": "Client listener for entity EntityCatalogDeleteEvent", "description": "Example of a client listener for receiving the notification EntityCatalogDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogBatchEvent": { "post": { "operationId": "listenToEntityCatalogBatchEvent", "summary": "Client listener for entity EntityCatalogBatchEvent", "description": "Example of a client listener for receiving the notification EntityCatalogBatchEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogBatchEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCategoryCreateEvent": { "post": { "operationId": "listenToEntityCategoryCreateEvent", "summary": "Client listener for entity EntityCategoryCreateEvent", "description": "Example of a client listener for receiving the notification EntityCategoryCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCategoryCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCategoryAttributeValueChangeEvent": { "post": { "operationId": "listenToEntityCategoryAttributeValueChangeEvent", "summary": "Client listener for entity EntityCategoryAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification EntityCategoryAttributeValueChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCategoryAttributeValueChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCategoryStateChangeEvent": { "post": { "operationId": "listenToEntityCategoryStateChangeEvent", "summary": "Client listener for entity EntityCategoryStateChangeEvent", "description": "Example of a client listener for receiving the notification EntityCategoryStateChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCategoryStateChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCategoryDeleteEvent": { "post": { "operationId": "listenToEntityCategoryDeleteEvent", "summary": "Client listener for entity EntityCategoryDeleteEvent", "description": "Example of a client listener for receiving the notification EntityCategoryDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCategoryDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogItemCreateEvent": { "post": { "operationId": "listenToEntityCatalogItemCreateEvent", "summary": "Client listener for entity EntityCatalogItemCreateEvent", "description": "Example of a client listener for receiving the notification EntityCatalogItemCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogItemCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogItemAttributeValueChangeEvent": { "post": { "operationId": "listenToEntityCatalogItemAttributeValueChangeEvent", "summary": "Client listener for entity EntityCatalogItemAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification EntityCatalogItemAttributeValueChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogItemAttributeValueChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogItemStateChangeEvent": { "post": { "operationId": "listenToEntityCatalogItemStateChangeEvent", "summary": "Client listener for entity EntityCatalogItemStateChangeEvent", "description": "Example of a client listener for receiving the notification EntityCatalogItemStateChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogItemStateChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entityCatalogItemDeleteEvent": { "post": { "operationId": "listenToEntityCatalogItemDeleteEvent", "summary": "Client listener for entity EntityCatalogItemDeleteEvent", "description": "Example of a client listener for receiving the notification EntityCatalogItemDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntityCatalogItemDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entitySpecificationCreateEvent": { "post": { "operationId": "listenToEntitySpecificationCreateEvent", "summary": "Client listener for entity EntitySpecificationCreateEvent", "description": "Example of a client listener for receiving the notification EntitySpecificationCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntitySpecificationCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entitySpecificationAttributeValueChangeEvent": { "post": { "operationId": "listenToEntitySpecificationAttributeValueChangeEvent", "summary": "Client listener for entity EntitySpecificationAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification EntitySpecificationAttributeValueChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntitySpecificationAttributeValueChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entitySpecificationStateChangeEvent": { "post": { "operationId": "listenToEntitySpecificationStateChangeEvent", "summary": "Client listener for entity EntitySpecificationStateChangeEvent", "description": "Example of a client listener for receiving the notification EntitySpecificationStateChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntitySpecificationStateChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/entitySpecificationDeleteEvent": { "post": { "operationId": "listenToEntitySpecificationDeleteEvent", "summary": "Client listener for entity EntitySpecificationDeleteEvent", "description": "Example of a client listener for receiving the notification EntitySpecificationDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/EntitySpecificationDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationSpecificationCreateEvent": { "post": { "operationId": "listenToAssociationSpecificationCreateEvent", "summary": "Client listener for entity AssociationSpecificationCreateEvent", "description": "Example of a client listener for receiving the notification AssociationSpecificationCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationSpecificationCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationSpecificationAttributeValueChangeEvent": { "post": { "operationId": "listenToAssociationSpecificationAttributeValueChangeEvent", "summary": "Client listener for entity AssociationSpecificationAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification AssociationSpecificationAttributeValueChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationSpecificationAttributeValueChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationSpecificationStateChangeEvent": { "post": { "operationId": "listenToAssociationSpecificationStateChangeEvent", "summary": "Client listener for entity AssociationSpecificationStateChangeEvent", "description": "Example of a client listener for receiving the notification AssociationSpecificationStateChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationSpecificationStateChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationSpecificationDeleteEvent": { "post": { "operationId": "listenToAssociationSpecificationDeleteEvent", "summary": "Client listener for entity AssociationSpecificationDeleteEvent", "description": "Example of a client listener for receiving the notification AssociationSpecificationDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationSpecificationDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationCreateEvent": { "post": { "operationId": "listenToAssociationCreateEvent", "summary": "Client listener for entity AssociationCreateEvent", "description": "Example of a client listener for receiving the notification AssociationCreateEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationCreateEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationAttributeValueChangeEvent": { "post": { "operationId": "listenToAssociationAttributeValueChangeEvent", "summary": "Client listener for entity AssociationAttributeValueChangeEvent", "description": "Example of a client listener for receiving the notification AssociationAttributeValueChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationAttributeValueChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationStateChangeEvent": { "post": { "operationId": "listenToAssociationStateChangeEvent", "summary": "Client listener for entity AssociationStateChangeEvent", "description": "Example of a client listener for receiving the notification AssociationStateChangeEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationStateChangeEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/listener/associationDeleteEvent": { "post": { "operationId": "listenToAssociationDeleteEvent", "summary": "Client listener for entity AssociationDeleteEvent", "description": "Example of a client listener for receiving the notification AssociationDeleteEvent", "tags": [ "notification listeners (client side)" ], "parameters": [ { "name": "data", "required": true, "in": "body", "description": "The event data", "schema": { "$ref": "#/definitions/AssociationDeleteEvent" } } ], "responses": { "201": { "description": "Notified", "schema": { "$ref": "#/definitions/EventSubscription" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Error" } }, "405": { "description": "Method Not allowed", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/Error" } } } } } }, "definitions": { "Addressable": { "type": "object", "description": "Base schema for adressable entities", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" } } }, "Any": {}, "Association": { "description": "Association is the class that describes a relationship between two or more entities or entity specifications based on a given association specification. The role of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the association" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "The last modified date of this association object" }, "lifecycleStatus": { "type": "string", "description": "Indicates the current lifecycle status" }, "name": { "type": "string", "description": "Name given to this association" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this association is valid" }, "version": { "type": "string", "description": "Version of this REST resource" }, "associationSpec": { "$ref": "#/definitions/AssociationSpecificationRef", "description": "The specification of this association" }, "associationRole": { "type": "array", "items": { "$ref": "#/definitions/AssociationRole" }, "minItems": 2, "description": "The end point roles of this association" }, "constraint": { "description": "Any constraints in this association", "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" } }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "Association_Create": { "type": "object", "description": "Association is the class that describes a relationship between two or more entities or entity specifications based on a given association specification. The role of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification\nSkipped properties: id,href", "required": [ "name", "associationRole" ], "properties": { "description": { "type": "string", "description": "Description of the association" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "The last modified date of this association object" }, "lifecycleStatus": { "type": "string", "description": "Indicates the current lifecycle status" }, "name": { "type": "string", "description": "Name given to this association" }, "version": { "type": "string", "description": "Version of this REST resource" }, "associationRole": { "$ref": "#/definitions/AssociationRole", "description": "The end point roles of this association" }, "associationSpec": { "$ref": "#/definitions/AssociationSpecificationRef", "description": "The specification of this association" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "Any constraints in this association" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this association is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "Association_Update": { "type": "object", "description": "Association is the class that describes a relationship between two or more entities or entity specifications based on a given association specification. The role of each endpoint in the relationship is given by an association role. The type of endpoints in the relationship should match the ones as defined in the corresponding association role specification. A relationship between entity specifications may be governed by conditions and rules which are addressed by constraint references in this resource. Constraints for a relationship may include new rules and conditions in addition to those defined for the corresponding association specification\nSkipped properties: id,href,lastUpdate,@type,@schemaLocation,@baseType", "properties": { "description": { "type": "string", "description": "Description of the association" }, "lifecycleStatus": { "type": "string", "description": "Indicates the current lifecycle status" }, "name": { "type": "string", "description": "Name given to this association" }, "version": { "type": "string", "description": "Version of this REST resource" }, "associationRole": { "$ref": "#/definitions/AssociationRole", "description": "The end point roles of this association" }, "associationSpec": { "$ref": "#/definitions/AssociationSpecificationRef", "description": "The specification of this association" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "Any constraints in this association" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this association is valid" } } }, "AssociationRole": { "type": "object", "description": "This embedded object represents the role and type of each entity involved in a relationship.", "required": [ "entity", "role" ], "properties": { "isSource": { "type": "boolean", "description": "A flag indicating if the participant involved in a relationship is the source or not. If this flag is true for both roles in an association, the association is bi-directional (both end points are navigable)" }, "role": { "type": "string", "description": "The association role of this relationship participant as defined in the associationRoleSpecification" }, "entity": { "$ref": "#/definitions/EntityRef", "description": "The entity being referred to" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "AssociationRoleSpecification": { "type": "object", "description": "This embedded object represents the role and type of each entity involved in a relationship.", "properties": { "aggregation": { "type": "string", "description": "A flag indicates that if this role is an aggregation or a simple relationship" }, "defaultQuantity": { "type": "integer", "description": "Default quantity of the association role" }, "entityType": { "type": "string", "description": "The target (root) entity type associated with this role" }, "isNavigable": { "type": "boolean", "description": "A flag indicating if access from the other end of association is allowed or not" }, "isSource": { "type": "boolean", "description": "A flag indicating if the participant involved in a uni-directional relationship is the source or not. This flag is true If the association is bi-directional" }, "maxQuantity": { "type": "integer", "description": "Maximum allowed quantity of the association role" }, "minQuantity": { "type": "integer", "description": "Minimum allowed quantity of the association role" }, "role": { "type": "string", "description": "The association role of this relationship participant" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "AssociationSpecification": { "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of the specification" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "The last modified date of this specification" }, "lifecycleStatus": { "type": "string", "description": "Indicates the current lifecycle status" }, "name": { "type": "string", "description": "Name given to this association specification" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this specification is valid" }, "version": { "type": "string", "description": "Version of this association" }, "constraint": { "type": "array", "description": "Constraints relating to this association", "items": { "$ref": "#/definitions/ConstraintRef" } }, "associationRoleSpec": { "type": "array", "description": "Role specifications for this association", "minItems": 2, "items": { "$ref": "#/definitions/AssociationRoleSpecification" } }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "id": { "type": "string", "description": "unique identifier" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name" } } }, "AssociationSpecification_Create": { "type": "object", "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.\nSkipped properties: id,href", "required": [ "name", "associationRoleSpec" ], "properties": { "description": { "type": "string", "description": "Description of the specification" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "The last modified date of this specification" }, "lifecycleStatus": { "type": "string", "description": "Indicates the current lifecycle status" }, "name": { "type": "string", "description": "Name given to this association specification" }, "version": { "type": "string", "description": "Version of this association" }, "associationRoleSpec": { "$ref": "#/definitions/AssociationRoleSpecification", "description": "Role specifications for this association" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "Constraints relating to this association" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this specification is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "AssociationSpecification_Update": { "type": "object", "description": "AssociationSpecification is an association class that describes a type of relationship between two entities. This is a generic construct that may be used to describe relationship types and roles. The role and type of each entity in the relationship is given by an association role specification. Two role specifications are embedded in the association specification.\nSkipped properties: id,href,lastUpdate,@type,@schemaLocation,@baseType", "properties": { "description": { "type": "string", "description": "Description of the specification" }, "lifecycleStatus": { "type": "string", "description": "Indicates the current lifecycle status" }, "name": { "type": "string", "description": "Name given to this association specification" }, "version": { "type": "string", "description": "Version of this association" }, "associationRoleSpec": { "$ref": "#/definitions/AssociationRoleSpecification", "description": "Role specifications for this association" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "Constraints relating to this association" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this specification is valid" } } }, "AssociationSpecificationRef": { "type": "object", "description": "reference to an AssociationSpecification object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "Attachment": { "type": "object", "description": "Complements the description of an element (for instance a product) through video, pictures...", "properties": { "id": { "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "description": "Unique identifier for this particular attachment" }, "href": { "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "format": "uri", "description": "URI for this Attachment" }, "attachmentType": { "example": "video", "type": "string", "description": "Attachment type such as video, picture" }, "content": { "type": "string", "format": "base64", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "description": { "example": "Photograph of the Product", "type": "string", "description": "A narrative text describing the content of the attachment" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "name": { "type": "string", "description": "The name of the attachment" }, "url": { "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "format": "uri", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "size": { "$ref": "#/definitions/Quantity", "description": "The size of the attachment." }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period of time for which the attachment is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "AttachmentRef": { "type": "object", "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures", "properties": { "id": { "type": "string", "description": "Unique-Identifier for this attachment" }, "href": { "type": "string", "format": "uri", "description": "URL serving as reference for the attachment resource" }, "description": { "type": "string", "description": "A narrative text describing the content of the attachment" }, "name": { "type": "string", "description": "Name of the related entity." }, "url": { "type": "string", "format": "uri", "description": "Link to the attachment media/content" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "AttachmentRefOrValue": { "type": "object", "description": "An attachment by value or by reference. An attachment complements the description of an element, for example through a document, a video, a picture.", "properties": { "id": { "example": "4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "description": "Unique identifier for this particular attachment" }, "href": { "example": "http://host/Attachment/4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "format": "uri", "description": "URI for this Attachment" }, "attachmentType": { "example": "video", "type": "string", "description": "Attachment type such as video, picture" }, "content": { "type": "string", "format": "base64", "description": "The actual contents of the attachment object, if embedded, encoded as base64" }, "description": { "example": "Photograph of the Product", "type": "string", "description": "A narrative text describing the content of the attachment" }, "mimeType": { "type": "string", "description": "Attachment mime type such as extension file for video, picture and document" }, "name": { "type": "string", "description": "The name of the attachment" }, "url": { "example": "http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f", "type": "string", "format": "uri", "description": "Uniform Resource Locator, is a web page address (a subset of URI)" }, "size": { "$ref": "#/definitions/Quantity", "description": "The size of the attachment." }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period of time for which the attachment is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "CharacteristicSpecification": { "type": "object", "description": "This class defines a characteristic specification.", "properties": { "id": { "type": "string", "description": "Unique ID for the characteristic" }, "configurable": { "type": "boolean", "description": "If true, the Boolean indicates that the target Characteristic is configurable" }, "description": { "type": "string", "description": "A narrative that explains the CharacteristicSpecification." }, "extensible": { "type": "boolean", "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource." }, "isUnique": { "type": "boolean", "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality": { "type": "integer", "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." }, "minCardinality": { "type": "integer", "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." }, "name": { "type": "string", "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." }, "regex": { "type": "string", "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "charSpecRelationship": { "type": "array", "items": { "$ref": "#/definitions/CharacteristicSpecificationRelationship" }, "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Specification Characteristics." }, "characteristicValueSpecification": { "type": "array", "items": { "$ref": "#/definitions/CharacteristicValueSpecification" }, "description": "A CharacteristicValueSpecification object is used to define a set of attributes, each of which can be assigned to a corresponding set of attributes in a CharacteristicSpecification object. The values of the attributes in the CharacteristicValueSpecification object describe the values of the attributes that a corresponding Characteristic object can take on." }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period of time for which a characteristic is applicable." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@valueSchemaLocation": { "type": "string", "description": "This (optional) field provides a link to the schema describing the value type." } } }, "CharacteristicSpecificationBase": { "type": "object", "description": "This class defines a characteristic specification.", "properties": { "id": { "type": "string", "description": "Unique ID for the characteristic" }, "configurable": { "type": "boolean", "description": "If true, the Boolean indicates that the target Characteristic is configurable" }, "description": { "type": "string", "description": "A narrative that explains the CharacteristicSpecification." }, "extensible": { "type": "boolean", "description": "An indicator that specifies that the values for the characteristic can be extended by adding new values when instantiating a characteristic for a resource." }, "isUnique": { "type": "boolean", "description": "An indicator that specifies if a value is unique for the specification. Possible values are; \"unique while value is in effect\" and \"unique whether value is in effect or not\"" }, "maxCardinality": { "type": "integer", "description": "The maximum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where five is the value for the maxCardinality." }, "minCardinality": { "type": "integer", "description": "The minimum number of instances a CharacteristicValue can take on. For example, zero to five phone numbers in a group calling plan, where zero is the value for the minCardinality." }, "name": { "type": "string", "description": "A word, term, or phrase by which this characteristic specification is known and distinguished from other characteristic specifications." }, "regex": { "type": "string", "description": "A rule or principle represented in regular expression used to derive the value of a characteristic value." }, "valueType": { "type": "string", "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period of time for which a characteristic is applicable." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@valueSchemaLocation": { "type": "string", "description": "This (optional) field provides a link to the schema describing the value type." } } }, "CharacteristicSpecificationRelationship": { "type": "object", "description": "An aggregation, migration, substitution, dependency or exclusivity relationship between/among Characteristic specifications. The specification characteristic is embedded within the specification whose ID and href are in this entity, and identified by its ID.", "properties": { "characteristicSpecificationId": { "type": "string", "description": "Unique identifier of the characteristic within the specification" }, "name": { "type": "string", "description": "Name of the target characteristic within the specification" }, "parentSpecificationHref": { "type": "string", "format": "uri", "description": "Hyperlink reference to the parent specification containing the target characteristic" }, "parentSpecificationId": { "type": "string", "description": "Unique identifier of the parent specification containing the target characteristic" }, "relationshipType": { "type": "string", "description": "Type of relationship such as aggregation, migration, substitution, dependency, exclusivity" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the object is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "CharacteristicValueSpecification": { "type": "object", "description": "specification of a value (number or text or an object) that can be assigned to a Characteristic.", "properties": { "isDefault": { "type": "boolean", "description": "If true, the Boolean Indicates if the value is the default value for a characteristic" }, "rangeInterval": { "type": "string", "description": "An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are \"open\", \"closed\", \"closedBottom\" and \"closedTop\"." }, "regex": { "type": "string", "description": "A regular expression constraint for given value" }, "unitOfMeasure": { "type": "string", "description": "A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot." }, "valueFrom": { "type": "integer", "description": "The low range value that a characteristic can take on" }, "valueTo": { "type": "integer", "description": "The upper range value that a characteristic can take on" }, "valueType": { "type": "string", "description": "A kind of value that the characteristic value can take on, such as numeric, text and so forth" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period of time for which a value is applicable." }, "value": { "$ref": "#/definitions/Any", "description": "A discrete value that the characteristic can take on, or the actual value of the characteristic" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ConstraintRef": { "type": "object", "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "constraint version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "Entity": { "type": "object", "description": "Base entity schema for use in TMForum Open-APIs", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCatalog": { "type": "object", "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any TMF data model entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "description": { "type": "string", "description": "Description of this catalog" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the catalog" }, "version": { "type": "string", "description": "Catalog version" }, "category": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" }, "description": "The categories used in this catalog" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" }, "description": "The parties who are involved or have an interest in this catalog" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the catalog is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCatalog_Create": { "type": "object", "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any TMF data model entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.\nSkipped properties: id,href", "required": [ "name" ], "properties": { "description": { "type": "string", "description": "Description of this catalog" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the catalog" }, "version": { "type": "string", "description": "Catalog version" }, "category": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" }, "description": "The categories used in this catalog" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" }, "description": "The parties who are involved or have an interest in this catalog" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the catalog is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCatalog_Update": { "type": "object", "description": "The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need.\nIn comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any TMF data model entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it does not replace them. It is primarily intended to address those entities which may not be addressed by any of Product, Service or Resource catalog.\nAn entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.\nSkipped properties: id,href,lastUpdate,@type,@schemaLocation,@baseType", "properties": { "description": { "type": "string", "description": "Description of this catalog" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the catalog" }, "version": { "type": "string", "description": "Catalog version" }, "category": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" }, "description": "The categories used in this catalog" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" }, "description": "The parties who are involved or have an interest in this catalog" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the catalog is valid" } } }, "EntityCatalogItem": { "type": "object", "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "description": { "type": "string", "description": "Description of this REST resource" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update of this REST resource" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "EntityCatalogItem version" }, "category": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" } }, "specification": { "$ref": "#/definitions/EntitySpecificationRef", "description": "The specification implied by this candidate" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this REST resource is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCatalogItem_Create": { "type": "object", "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.\nSkipped properties: id,href", "required": [ "name", "specification" ], "properties": { "description": { "type": "string", "description": "Description of this REST resource" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update of this REST resource" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "EntityCatalogItem version" }, "category": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" } }, "specification": { "$ref": "#/definitions/EntitySpecificationRef", "description": "The specification implied by this candidate" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this REST resource is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCatalogItem_Update": { "type": "object", "description": "An EntityCatalogItem is an entity that allows any ProductOffering, ServiceCandidate, ResourceCandidate, or even any object inheriting from RootEntity, to be available to a catalog. The CatalogSpecification and Policy of the catalog governs the content of the EntityCatalogItem. This API addresses only EntitySpecification items extended from RootEntity as EntityCatalogItem.\nThe EntityCatalogItem resource (JSON format) represents a set of characteristics that define the values given by the EntityCatalogItem.\nSkipped properties: id,href,lastUpdate,@type,@schemaLocation,@baseType", "properties": { "description": { "type": "string", "description": "Description of this REST resource" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to this REST resource" }, "version": { "type": "string", "description": "EntityCatalogItem version" }, "category": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" } }, "specification": { "$ref": "#/definitions/EntitySpecificationRef", "description": "The specification implied by this candidate" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this REST resource is valid" } } }, "EntityCatalogItemRef": { "type": "object", "description": "reference to EntityCatalogItem object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "EntityCatalogItem version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "EntityCategory": { "type": "object", "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.\nResource IDs for categories are strings and are defined by the catalog application.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "description": { "type": "string", "description": "Description of the category" }, "isRoot": { "type": "boolean", "description": "If true, this Boolean indicates that the category is a root of categories" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the category" }, "parentId": { "type": "string", "description": "Unique identifier of the parent category" }, "version": { "type": "string", "description": "Category version" }, "childCategory": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" }, "description": "The child category(ies) if any, contained in this category" }, "entityCatalogItem": { "type": "array", "items": { "$ref": "#/definitions/EntityCatalogItemRef" }, "description": "The catalog items referred to by this category" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the category is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCategory_Create": { "type": "object", "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.\nResource IDs for categories are strings and are defined by the catalog application.\nSkipped properties: id,href", "required": [ "name" ], "properties": { "description": { "type": "string", "description": "Description of the category" }, "isRoot": { "type": "boolean", "description": "If true, this Boolean indicates that the category is a root of categories" }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the category" }, "parentId": { "type": "string", "description": "Unique identifier of the parent category" }, "version": { "type": "string", "description": "Category version" }, "childCategory": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" }, "description": "The child category(ies) if any, contained in this category" }, "entityCatalogItem": { "type": "array", "items": { "$ref": "#/definitions/EntityCatalogItemRef" }, "description": "The catalog items referred to by this category" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the category is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntityCategory_Update": { "type": "object", "description": "The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.\nResource IDs for categories are strings and are defined by the catalog application.\nSkipped properties: id,href,lastUpdate,@type,@schemaLocation,@baseType", "properties": { "description": { "type": "string", "description": "Description of the category" }, "isRoot": { "type": "boolean", "description": "If true, this Boolean indicates that the category is a root of categories" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status" }, "name": { "type": "string", "description": "Name of the category" }, "parentId": { "type": "string", "description": "Unique identifier of the parent category" }, "version": { "type": "string", "description": "Category version" }, "childCategory": { "type": "array", "items": { "$ref": "#/definitions/EntityCategoryRef" }, "description": "The child category(ies) if any, contained in this category" }, "entityCatalogItem": { "type": "array", "items": { "$ref": "#/definitions/EntityCatalogItemRef" }, "description": "The catalog items referred to by this category" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the category is valid" } } }, "EntityCategoryRef": { "type": "object", "description": "Reference to Entity Category object. The (entity) category resource is used to group entity catalog items in logical containers. Categories can contain other categories.\nResource IDs for categories are strings and are defined by the catalog application.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "Category version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "EntityRef": { "type": "object", "description": "Entity reference schema to be use for all entityRef class.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "EntitySpecification": { "type": "object", "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.\nFunctionally, the entity specification acts as a template by which entities may be instantiated and described. By sharing the same specification, these entities would therefore share the same set of characteristics.\nNote: The \u2018configurable\u2019 attribute on the specCharacteristics determines if an entity instantiated from the entity specification can override the value of the attribute. When set to false, the entity instance may not define a value that differs from the value in the specification.", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "description": { "type": "string", "description": "Description of the specification" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether specification represents a single specification (false), or a bundle of specifications (true)." }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update of the specification" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to the specification" }, "version": { "type": "string", "description": "specification version" }, "attachment": { "type": "array", "items": { "$ref": "#/definitions/AttachmentRefOrValue" }, "description": "Attachments that may be of relevance to this specification, such as picture, document, media" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "This is a list of constraint references applied to this specification" }, "entitySpecRelationship": { "type": "array", "items": { "$ref": "#/definitions/EntitySpecificationRelationship" }, "description": "Relationship to another specification" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" }, "description": "Parties who manage or otherwise have an interest in this specification" }, "specCharacteristic": { "type": "array", "items": { "$ref": "#/definitions/CharacteristicSpecification" }, "description": "List of characteristics that the entity can take" }, "targetEntitySchema": { "$ref": "#/definitions/TargetEntitySchema", "description": "Pointer to a schema that defines the target entity" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this REST resource is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntitySpecification_Create": { "type": "object", "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.\nFunctionally, the entity specification acts as a template by which entities may be instantiated and described. By sharing the same specification, these entities would therefore share the same set of characteristics.\nNote: The \u2018configurable\u2019 attribute on the specCharacteristics determines if an entity instantiated from the entity specification can override the value of the attribute. When set to false, the entity instance may not define a value that differs from the value in the specification.\nSkipped properties: id,href", "required": [ "name", "@type" ], "properties": { "description": { "type": "string", "description": "Description of the specification" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether specification represents a single specification (false), or a bundle of specifications (true)." }, "lastUpdate": { "type": "string", "format": "date-time", "description": "Date and time of the last update of the specification" }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to the specification" }, "version": { "type": "string", "description": "specification version" }, "attachment": { "type": "array", "items": { "$ref": "#/definitions/AttachmentRefOrValue" }, "description": "Attachments that may be of relevance to this specification, such as picture, document, media" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "This is a list of constraint references applied to this specification" }, "entitySpecRelationship": { "type": "array", "items": { "$ref": "#/definitions/EntitySpecificationRelationship" }, "description": "Relationship to another specification" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" }, "description": "Parties who manage or otherwise have an interest in this specification" }, "specCharacteristic": { "type": "array", "items": { "$ref": "#/definitions/CharacteristicSpecification" }, "description": "List of characteristics that the entity can take" }, "targetEntitySchema": { "$ref": "#/definitions/TargetEntitySchema", "description": "Pointer to a schema that defines the target entity" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this REST resource is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "EntitySpecification_Update": { "type": "object", "description": "EntitySpecification is a class that offers characteristics to describe a type of entity. Entities are generic constructs that may be used to describe bespoke business entities that are not effectively covered by the existing SID model.\nFunctionally, the entity specification acts as a template by which entities may be instantiated and described. By sharing the same specification, these entities would therefore share the same set of characteristics.\nNote: The \u2018configurable\u2019 attribute on the specCharacteristics determines if an entity instantiated from the entity specification can override the value of the attribute. When set to false, the entity instance may not define a value that differs from the value in the specification.\nSkipped properties: id,href,lastUpdate,@type,@schemaLocation,@baseType", "properties": { "description": { "type": "string", "description": "Description of the specification" }, "isBundle": { "type": "boolean", "description": "isBundle determines whether specification represents a single specification (false), or a bundle of specifications (true)." }, "lifecycleStatus": { "type": "string", "description": "Used to indicate the current lifecycle status of this catalog item" }, "name": { "type": "string", "description": "Name given to the specification" }, "version": { "type": "string", "description": "specification version" }, "attachment": { "type": "array", "items": { "$ref": "#/definitions/AttachmentRefOrValue" }, "description": "Attachments that may be of relevance to this specification, such as picture, document, media" }, "constraint": { "type": "array", "items": { "$ref": "#/definitions/ConstraintRef" }, "description": "This is a list of constraint references applied to this specification" }, "entitySpecRelationship": { "type": "array", "items": { "$ref": "#/definitions/EntitySpecificationRelationship" }, "description": "Relationship to another specification" }, "relatedParty": { "type": "array", "items": { "$ref": "#/definitions/RelatedParty" }, "description": "Parties who manage or otherwise have an interest in this specification" }, "specCharacteristic": { "type": "array", "items": { "$ref": "#/definitions/CharacteristicSpecification" }, "description": "List of characteristics that the entity can take" }, "targetEntitySchema": { "$ref": "#/definitions/TargetEntitySchema", "description": "Pointer to a schema that defines the target entity" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which this REST resource is valid" } } }, "EntitySpecificationRef": { "type": "object", "description": "reference to an EntitySpecification object", "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "version": { "type": "string", "description": "EntitySpecification version" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } }, "required": [ "id" ] }, "EntitySpecificationRelationship": { "type": "object", "description": "A migration, substitution, dependency or exclusivity relationship between/among entity specifications.", "required": [ "relationshipType" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "relationshipType": { "type": "string", "description": "Type of relationship such as migration, substitution, dependency, exclusivity" }, "role": { "type": "string", "description": "The association role for this entity specification" }, "associationSpec": { "$ref": "#/definitions/AssociationSpecificationRef", "description": "A specification for an association used by this relationship" }, "validFor": { "$ref": "#/definitions/TimePeriod", "description": "The period for which the entitySpecRelationship is valid" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "ExportJob": { "type": "object", "description": "Represents a task used to export resources to a file", "properties": { "id": { "type": "string", "description": "Identifier of the export job" }, "href": { "type": "string", "format": "uri", "description": "Reference of the export job" }, "completionDate": { "type": "string", "format": "date-time", "description": "Data at which the job was completed" }, "contentType": { "type": "string", "description": "The format of the exported data" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date at which the job was created" }, "errorLog": { "type": "string", "description": "Reason for failure" }, "path": { "type": "string", "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" }, "query": { "type": "string", "description": "Used to scope the exported data" }, "url": { "type": "string", "format": "uri", "description": "URL of the file containing the data to be exported" }, "status": { "$ref": "#/definitions/JobStateType", "description": "Status of the export job (not started, running, succeeded, failed)" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ExportJob_Create": { "type": "object", "description": "Represents a task used to export resources to a file\nSkipped properties: id,href", "required": [ "url" ], "properties": { "completionDate": { "type": "string", "format": "date-time", "description": "Data at which the job was completed" }, "contentType": { "type": "string", "description": "The format of the exported data" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date at which the job was created" }, "errorLog": { "type": "string", "description": "Reason for failure" }, "path": { "type": "string", "description": "URL of the root resource acting as the source for streaming content to the file specified by the export job" }, "query": { "type": "string", "description": "Used to scope the exported data" }, "url": { "type": "string", "format": "uri", "description": "URL of the file containing the data to be exported" }, "status": { "$ref": "#/definitions/JobStateType", "description": "Status of the export job (not started, running, succeeded, failed)" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "Extensible": { "type": "object", "description": "Base Extensible schema for use in TMForum Open-APIs", "properties": { "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ImportJob": { "type": "object", "description": "Represents a task used to import resources from a file", "properties": { "id": { "type": "string", "description": "Identifier of the import job" }, "href": { "type": "string", "format": "uri", "description": "Reference of the import job" }, "completionDate": { "type": "string", "format": "date-time", "description": "Date at which the job was completed" }, "contentType": { "type": "string", "description": "Indicates the format of the imported data" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date at which the job was created" }, "errorLog": { "type": "string", "description": "Reason for failure if status is failed" }, "path": { "type": "string", "description": "URL of the root resource where the content of the file specified by the import job must be applied" }, "url": { "type": "string", "format": "uri", "description": "URL of the file containing the data to be imported" }, "status": { "$ref": "#/definitions/JobStateType", "description": "Status of the import job (not started, running, succeeded, failed)" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "ImportJob_Create": { "type": "object", "description": "Represents a task used to import resources from a file\nSkipped properties: id,href", "required": [ "url" ], "properties": { "completionDate": { "type": "string", "format": "date-time", "description": "Date at which the job was completed" }, "contentType": { "type": "string", "description": "Indicates the format of the imported data" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date at which the job was created" }, "errorLog": { "type": "string", "description": "Reason for failure if status is failed" }, "path": { "type": "string", "description": "URL of the root resource where the content of the file specified by the import job must be applied" }, "url": { "type": "string", "format": "uri", "description": "URL of the file containing the data to be imported" }, "status": { "$ref": "#/definitions/JobStateType", "description": "Status of the import job (not started, running, succeeded, failed)" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" } } }, "JobStateType": { "type": "string", "description": "Valid values for the state of a batch job (e.g. catalog import)", "enum": [ "Not Started", "Running", "Succeeded", "Failed" ] }, "Quantity": { "type": "object", "description": "An amount in a given unit", "properties": { "amount": { "default": 1, "type": "number", "format": "float", "description": "Numeric value in a given unit" }, "units": { "type": "string", "description": "Unit" } } }, "RelatedParty": { "type": "object", "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.", "required": [ "@referredType", "id" ], "properties": { "id": { "type": "string", "description": "unique identifier" }, "href": { "type": "string", "format": "uri", "description": "Hyperlink reference" }, "name": { "type": "string", "description": "Name of the related entity." }, "role": { "type": "string", "description": "Role played by the related party" }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class" }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class Extensible name" }, "@referredType": { "type": "string", "description": "The actual type of the target instance when needed for disambiguation." } } }, "TargetEntitySchema": { "type": "object", "description": "The reference object to the schema and type of target entity which is described by a specification", "required": [ "@schemaLocation", "@type" ], "properties": { "@schemaLocation": { "type": "string", "description": "This field provides a link to the schema describing the target entity" }, "@type": { "type": "string", "description": "Class type of the target entity" } } }, "TimePeriod": { "type": "object", "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both", "properties": { "endDateTime": { "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time", "description": "End of the time period, using IETC-RFC-3339 format" }, "startDateTime": { "example": "1985-04-12T23:20:50.52Z", "type": "string", "format": "date-time", "description": "Start of the time period, using IETC-RFC-3339 format" } } }, "EventSubscription": { "type": "object", "description": "Sets the communication endpoint address the service instance must use to deliver notification information", "required": [ "id", "callback" ], "properties": { "id": { "type": "string", "description": "Id of the listener" }, "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } } }, "EventSubscriptionInput": { "type": "object", "description": "Sets the communication endpoint address the service instance must use to deliver notification information", "required": [ "callback" ], "properties": { "callback": { "type": "string", "description": "The callback being registered." }, "query": { "type": "string", "description": "additional data to be passed" } } }, "EntityCatalogCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalog": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalog" } } }, "EntityCatalogAttributeValueChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogAttributeValueChangeEventPayload" } } }, "EntityCatalogAttributeValueChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalog": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalog" } } }, "EntityCatalogStateChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogStateChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalog": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalog" } } }, "EntityCatalogDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalog": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalog" } } }, "EntityCatalogBatchEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogBatchEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogBatchEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalog": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalog" } } }, "EntityCategoryCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCategoryCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCategoryCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCategory": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCategory" } } }, "EntityCategoryAttributeValueChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCategoryAttributeValueChangeEventPayload" } } }, "EntityCategoryAttributeValueChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCategory": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCategory" } } }, "EntityCategoryStateChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCategoryStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCategoryStateChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCategory": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCategory" } } }, "EntityCategoryDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCategoryDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCategoryDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCategory": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCategory" } } }, "EntityCatalogItemCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogItemCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogItemCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalogItem": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalogItem" } } }, "EntityCatalogItemAttributeValueChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogItemAttributeValueChangeEventPayload" } } }, "EntityCatalogItemAttributeValueChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalogItem": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalogItem" } } }, "EntityCatalogItemStateChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogItemStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogItemStateChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalogItem": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalogItem" } } }, "EntityCatalogItemDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntityCatalogItemDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntityCatalogItemDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entityCatalogItem": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntityCatalogItem" } } }, "EntitySpecificationCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntitySpecificationCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntitySpecificationCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entitySpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntitySpecification" } } }, "EntitySpecificationAttributeValueChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntitySpecificationAttributeValueChangeEventPayload" } } }, "EntitySpecificationAttributeValueChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entitySpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntitySpecification" } } }, "EntitySpecificationStateChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntitySpecificationStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntitySpecificationStateChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entitySpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntitySpecification" } } }, "EntitySpecificationDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/EntitySpecificationDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "EntitySpecificationDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "entitySpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/EntitySpecification" } } }, "AssociationSpecificationCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationSpecificationCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "AssociationSpecificationCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "associationSpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/AssociationSpecification" } } }, "AssociationSpecificationAttributeValueChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationSpecificationAttributeValueChangeEventPayload" } } }, "AssociationSpecificationAttributeValueChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "associationSpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/AssociationSpecification" } } }, "AssociationSpecificationStateChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationSpecificationStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "AssociationSpecificationStateChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "associationSpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/AssociationSpecification" } } }, "AssociationSpecificationDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationSpecificationDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "AssociationSpecificationDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "associationSpecification": { "description": "The involved resource data for the event", "$ref": "#/definitions/AssociationSpecification" } } }, "AssociationCreateEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationCreateEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "AssociationCreateEventPayload": { "type": "object", "description": "The event data structure", "properties": { "association": { "description": "The involved resource data for the event", "$ref": "#/definitions/Association" } } }, "AssociationAttributeValueChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." }, "fieldPath": { "type": "string", "description": "The path identifying the object field concerned by this notification." }, "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationAttributeValueChangeEventPayload" } } }, "AssociationAttributeValueChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "association": { "description": "The involved resource data for the event", "$ref": "#/definitions/Association" } } }, "AssociationStateChangeEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationStateChangeEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "AssociationStateChangeEventPayload": { "type": "object", "description": "The event data structure", "properties": { "association": { "description": "The involved resource data for the event", "$ref": "#/definitions/Association" } } }, "AssociationDeleteEvent": { "type": "object", "description": "The notification data structure", "properties": { "event": { "description": "The event payload linked to the involved resource object", "$ref": "#/definitions/AssociationDeleteEventPayload" }, "eventId": { "type": "string", "description": "The identifier of the notification." }, "eventTime": { "type": "string", "format": "date-time", "description": "Time of the event occurrence." }, "eventType": { "type": "string", "description": "The type of the notification." }, "correlationId": { "type": "string", "description": "The correlation id for this event." }, "domain": { "type": "string", "description": "The domain of the event." }, "title": { "type": "string", "description": "The title of the event." }, "description": { "type": "string", "description": "An explnatory of the event." }, "priority": { "type": "string", "description": "A priority." }, "timeOcurred": { "type": "string", "format": "date-time", "description": "The time the event occured." } } }, "AssociationDeleteEventPayload": { "type": "object", "description": "The event data structure", "properties": { "association": { "description": "The involved resource data for the event", "$ref": "#/definitions/Association" } } }, "Error": { "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)", "type": "object", "required": [ "code", "reason" ], "properties": { "code": { "type": "string", "description": "Application relevant detail, defined in the API or a common list." }, "reason": { "type": "string", "description": "Explanation of the reason for the error which can be shown to a client user." }, "message": { "type": "string", "description": "More details and corrective actions related to the error which can be shown to a client user." }, "status": { "type": "string", "description": "HTTP Error code extension" }, "referenceError": { "type": "string", "format": "uri", "description": "URI of documentation describing the error." }, "@baseType": { "type": "string", "description": "When sub-classing, this defines the super-class." }, "@schemaLocation": { "type": "string", "format": "uri", "description": "A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type": { "type": "string", "description": "When sub-classing, this defines the sub-class entity name." } } } } }