TDMModelService

TDMModelService
tdm40
none
{"swagger":"2.0","info":{"description":"This section includes the APIs that perform various operations for modeling the projects.It also provides the REST API URL for the respective operation along with sample request and response body content.","version":"1.0","title":"CA TDM Modeling Service API","termsOfService":"http://ca.com","contact":{"name":"CA Technologies"},"license":{"name":"The CA License Version 2.0","url":"https://ca.com/LICENSE"}},"host":"vtdm-dev-demo:8443","basePath":"/TDMModelService","tags":[{"name":"results-controller-data-model","description":"Results Controller Data Model"},{"name":"mask-settings-controller","description":"Mask Settings Controller"},{"name":"object-controller","description":"Interface for Objects"},{"name":"profiler-controller","description":"Profiler Controller"},{"name":"results-controller","description":"Results Controller"},{"name":"classifier-controller","description":"Classifier Controller"},{"name":"data-model-controller","description":"Data Model Controller"},{"name":"mask-function-group-controller","description":"Mask Function Group Controller"},{"name":"tags-controller","description":"Tags Controller"},{"name":"job-controller","description":"Job Controller"},{"name":"mask-config-by-tag-controller","description":"Mask Config By Tag Controller"},{"name":"where-clause-controller","description":"Where Clause Controller"}],"paths":{"/api/ca/v1/datamodel":{"delete":{"tags":["data-model-controller"],"summary":"Interface to delete all related data discovery data after a project version has been deleted","operationId":"onProjectVersionDeleteUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/attributes/{attributeId}":{"patch":{"tags":["data-model-controller"],"summary":"Interface to update Data Model Attribute of an Entity. Currently supports only updating of Alias.","operationId":"patchEntityAttributeUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"attributeId","in":"path","description":"Entity Attribute ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entityAttributeInfo","description":"Entity Attribute data that shall be updated.","required":true,"schema":{"$ref":"#/definitions/DataModelEntityAttributeInfo"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataModelEntityAttributeInfo"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/cancel":{"post":{"tags":["data-model-controller"],"summary":"Interface to cancel a running data discovery scan and clean up all related discovered data","operationId":"cancelDataDiscoveryScanUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"environmentId","in":"query","description":"Environment ID.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/confirm":{"post":{"tags":["data-model-controller"],"summary":"Interface to delete the most recent failed data discovery scan and related discovered data","operationId":"deleteLastDataDiscoveryScanUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"environmentId","in":"query","description":"Environment ID.","required":false,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/copyToVersion":{"post":{"tags":["data-model-controller"],"summary":"Interface to copy a datamodel between versions of a project.","operationId":"copyModelToVersionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"request","description":"request object contains id of new project","required":false,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/discoverRelationships":{"post":{"tags":["data-model-controller"],"summary":"Interface to scan on an environment to collect entity and attribute metadata as well as discover relationships between the entities","operationId":"discoverRelationshipsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"environmentId","in":"query","description":"Environment ID.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataDiscoveryJobDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/entities":{"get":{"tags":["data-model-controller"],"summary":"Interface to get entities and their properties, such as attributes and relationships","operationId":"getAllEntitiesUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"includeRelationships","in":"query","description":"Include relationships in response","required":false,"type":"boolean","default":false},{"name":"includeRelatedEntities","in":"query","description":"Include related entities in response","required":false,"type":"boolean","default":false},{"name":"includeAttributes","in":"query","description":"Include attributes in response","required":false,"type":"boolean","default":false},{"name":"includeHierarchy","in":"query","description":"Include hierarchy in response","required":false,"type":"boolean","default":false},{"name":"includeUniqueKeys","in":"query","description":"Include unique keys in response","required":false,"type":"boolean","default":false},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"q","in":"query","description":"Query parameter to search. e.g. entity=<value>+attribute=<value>+schema=<value>+database=<value>datasource=<value>","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DataModelEntityInfo"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/entities/maskConfigurations":{"get":{"tags":["mask-function-group-controller"],"summary":"Interface to get mask configurations of entities","description":"Use this interface to get the mask configurations of entities which are tagged as having PII.","operationId":"getEntitiesMaskInfoUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"q","in":"query","description":"Search criteria. RSQL format (see https://github.com/jirutka/rsql-parser ).Allows the query to be filtered e.g. on 'entityName'","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EntityMaskInfo"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/entities/{entityId}":{"get":{"tags":["data-model-controller"],"summary":"Interface to get entity and its properties, such as attributes and relationships","operationId":"getEntityUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"Entity ID","required":true,"type":"integer","format":"int64"},{"name":"includeRelationships","in":"query","description":"Include relationships in response","required":false,"type":"boolean","default":false},{"name":"includeRelatedEntities","in":"query","description":"Include related entities in response","required":false,"type":"boolean","default":false},{"name":"includeAttributes","in":"query","description":"Include attributes in response","required":false,"type":"boolean","default":false},{"name":"includeHierarchy","in":"query","description":"Include hierarchy in response","required":false,"type":"boolean","default":false},{"name":"includeUniqueKeys","in":"query","description":"Include unique keys in response","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataModelEntityInfo"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["data-model-controller"],"summary":"Interface to update Data Model Entity. Currently supports only updating of Alias.","operationId":"patchEntityUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"Entity ID","required":true,"type":"integer","format":"int64"},{"in":"body","name":"entityInfo","description":"Entity data that shall be updated.","required":true,"schema":{"$ref":"#/definitions/DataModelEntityInfo"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataModelEntityInfo"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/entities/{entityId}/attributes/{attributeId}/maskConfigurations":{"get":{"tags":["mask-function-group-controller"],"summary":"Interface to get the current mask configuration of an attribute","description":"Use this interface to get the current mask configuration of an attribute","operationId":"getAttribMaskFunctionGroupUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"entityId","required":true,"type":"integer","format":"int64"},{"name":"attributeId","in":"path","description":"attributeId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["mask-function-group-controller"],"summary":"Interface to set the mask function group of an attribute for a project version","description":"Use this interface to set the mask function group of an attribute for a project version","operationId":"postAttrMaskFunctionGroupUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"entityId","required":true,"type":"integer","format":"int64"},{"name":"attributeId","in":"path","description":"attributeId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroupId","description":"maskFunctionGroupId","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroupId"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["mask-function-group-controller"],"summary":"Interface to remove current mask function group from an attribute","description":"Use this interface to remove current mask function group from an attribute,","operationId":"deleteAttribMaskFunctionGroupUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"entityId","required":true,"type":"integer","format":"int64"},{"name":"attributeId","in":"path","description":"attributeId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["mask-function-group-controller"],"summary":"Interface to update the mask function group of an attribute for a project version","description":"Use this interface to update the mask function group of an attribute for a project version","operationId":"patchAttrMaskFunctionGroupUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"entityId","required":true,"type":"integer","format":"int64"},{"name":"attributeId","in":"path","description":"attributeId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroupId","description":"maskFunctionGroupId","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroupId"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/entities/{entityId}/maskConfigurations":{"get":{"tags":["mask-function-group-controller"],"summary":"Interface to get the list of attributes of an entity and their associated current masking configuration","description":"Use this interface to get the list of attributes of an entity and their associated current masking configuration","operationId":"getEntityMaskFunctionGroupUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityId","in":"path","description":"entityId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AttribMaskFunctionGroup"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/entityExclusions":{"get":{"tags":["data-model-controller"],"summary":"Interface to get entity exclusions for a project version","operationId":"getEntityExclusionsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityExclusionInfo"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["data-model-controller"],"summary":"Interface to add entity exclusions","operationId":"addEntityExclusionsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"exclusions","description":"Exclusions to add.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntityExclusion"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityExclusionInfo"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["data-model-controller"],"summary":"Interface to patch entity exclusion","operationId":"onPatchEntityExclusionsUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"updates","description":"Exclusions to add.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/EntityExclusion"}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityExclusionInfo"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/entityExclusions/{entityExclusionId}":{"delete":{"tags":["data-model-controller"],"summary":"Interface to delete a single entity exclusion","operationId":"onDeleteEntityExclusionUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"entityExclusionId","in":"path","description":"Entity Exclusion ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/environments/{environmentId}":{"delete":{"tags":["data-model-controller"],"summary":"Interface to delete all related data discovery data after an environment has been deleted","operationId":"onPostEnvironmentDeleteUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"environmentId","in":"path","description":"Environment ID.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/information":{"get":{"tags":["data-model-controller"],"summary":"Interface to get some data discovery information for a project version","operationId":"getDataDiscoveryInfoUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DataDiscoveryJobDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/maskConfigurations":{"get":{"tags":["mask-function-group-controller"],"summary":"Interface to get list of mask function groups","description":"Use this interface to get list of mask function groups which originate either from classifiers or from the specified project version.","operationId":"getMaskFunctionGroupsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"attributeId","in":"query","description":"Attribute ID.","required":false,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"q","in":"query","description":"Search criteria. RSQL format (see https://github.com/jirutka/rsql-parser ).Allows the query to be filtered e.g. on 'tagName', 'maskGroupShared' and 'attributeId'","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaskFunctionGroup"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["mask-function-group-controller"],"summary":"Interface to add a new mask function group to a project version","description":"Use this interface to add a new mask function group to a project version.","operationId":"postMaskFunctionGroupUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroup","description":"maskFunctionGroup","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroup"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/maskConfigurations/{maskFunctionGroupId}":{"get":{"tags":["mask-function-group-controller"],"summary":"Interface to get the details of a mask function group","description":"Use this interface to get the details of a mask function group","operationId":"getMaskFunctionGroupUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"maskFunctionGroupId","in":"path","description":"maskFunctionGroupId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["mask-function-group-controller"],"summary":"Interface to delete a mask function group","description":"Use this interface to delete a mask function group","operationId":"deleteMaskFunctionGroupUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"maskFunctionGroupId","in":"path","description":"maskFunctionGroupId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["mask-function-group-controller"],"summary":"Interface to update the details of a mask function group","description":"Use this interface to update the details of a mask function group","operationId":"patchMaskFunctionGroupUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"maskFunctionGroupId","in":"path","description":"maskFunctionGroupId","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroup","description":"maskFunctionGroup","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroup"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/maskConfigurations/{maskFunctionGroupId}/attributes":{"get":{"tags":["mask-function-group-controller"],"summary":"Interface to get the list of attributes linked to the specified masking function group","description":"Use this interface to get the list of attributes linked to the specified masking function group","operationId":"getAttribsMaskFunctionGroupUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"maskFunctionGroupId","in":"path","description":"maskFunctionGroupId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/AttribMaskFunctionGroup"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/maskSettings":{"get":{"tags":["mask-settings-controller"],"summary":"Interface to get the user masking settings for specified current project/version","operationId":"getSettingsUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"onlyUserSettings","in":"query","description":"Only return settings that the user had edited/updated","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaskSetting"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/maskSettings/{id}":{"get":{"tags":["mask-settings-controller"],"summary":"Interface to get the specific user masking setting for specified current project/version","operationId":"getSettingsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"Id of the masking settings to fetch.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaskSetting"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["mask-settings-controller"],"summary":"Interface to set the specific user masking setting for specified current project/version","operationId":"postSettingsUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"Id of the masking settings to set.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"setting","description":"The new value of the settings.","required":true,"schema":{"$ref":"#/definitions/MaskSetting"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaskSetting"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/preScan":{"post":{"tags":["data-model-controller"],"summary":"Interface to pre-scan on an environment to collect entity and attribute metadata but with no data discovery","operationId":"preScanEnvironmentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"environmentId","in":"query","description":"Environment ID.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataDiscoveryJobDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile":{"post":{"tags":["data-model-controller"],"summary":"Interface to perform a profile scan on a data model.","operationId":"profileUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"profileJobRequest","description":"job details.","required":true,"schema":{"$ref":"#/definitions/Job"}},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataDiscoveryJobDTO"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["data-model-controller"],"summary":"Interface to delete a profile scan on a data model.","operationId":"deleteProfileUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DataDiscoveryJobDTO"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/profile/actions/cancelJob":{"post":{"tags":["data-model-controller"],"summary":"Interface to cancel a profile scan job on the data model.","operationId":"cancelProfileJobUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile/job":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get a single job","operationId":"getAJobUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiJob"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile/piidata":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get the PII data for a job","description":"Returns potential PII data for a job a page at a time.","operationId":"getAJobsPiiDataUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"Page number if fetch, starting at 0","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Page size to fetch","required":false,"type":"integer","format":"int32"},{"name":"hasTags","in":"query","description":"Include columns with PII only ?","required":false,"type":"boolean"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"name":"q","in":"query","description":"Query parameter to search tags:, tables:, columns:, schema:, profile: or all of those","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiData"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile/piidata/{table}":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get the PII data for a single table","operationId":"getAJobsPiiDataForOneTableUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiData"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["results-controller-data-model"],"summary":"Interface to patch the PII data for a table","description":"Use this interface to either accept, reject or alter the PII data for a table","operationId":"patchAJobPiiDataUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiData"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiData"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/profile/piidata/{table}/columns":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get the PII data for all columms in a table","operationId":"getAJobsPiiDataForOneTableAndColumnsUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","format":"int32"},{"name":"hasTags","in":"query","description":"Include columns with PII only ?","required":false,"type":"boolean"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["results-controller-data-model"],"summary":"Interface to put or patch the PII data for several columns in a table","description":"Use this interface to either add or remove PII tags for several columns in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndManyColumnsUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["results-controller-data-model"],"summary":"Interface to put or patch the PII data for several columns in a table","description":"Use this interface to either add or remove PII tags for several columns in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndManyColumnsUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/profile/piidata/{table}/columns/{column}":{"put":{"tags":["results-controller-data-model"],"summary":"Interface to put or patch the PII data for a single columm in a table","description":"Use this interface to either add or remove PII tags for a single column in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndColumnsUsingPUT_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"column","in":"path","description":"column","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiDataColumn"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["results-controller-data-model"],"summary":"Interface to put or patch the PII data for a single columm in a table","description":"Use this interface to either add or remove PII tags for a single column in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndColumnsUsingPATCH_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"column","in":"path","description":"column","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiDataColumn"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/profile/report":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to download a PII Job report in CSV format","description":"For report class DRAFT, the report is generated on the fly. For TDE, AUDITOR or MANAGEMENT, the report is retrieved from the repository.","operationId":"getAJobAsCsvUsingGET_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"fileName","in":"query","description":"File name to be returned in content-disposition","required":false,"type":"string"},{"name":"format","in":"query","description":"Format of the report document","required":true,"type":"string","default":"csv","enum":["csv"]}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/InputStreamResource"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permission to access the report.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"When this REST end point is down or not accessible.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Check logs for more information.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/datamodel/profile/samples":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to return total samples stored for ","description":"Samples collected in a job can be fetched for a specified list of columms.","operationId":"getJobSamplesUsingGET_3","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["results-controller-data-model"],"summary":"Interface to delete stored samples from a job","operationId":"deleteJobSamplesUsingDELETE_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/profile/search":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to search for data within a data model.","description":"Used this interface to search for tables, columns, schema etc within a data model.","operationId":"searchUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"q","in":"query","description":"Query parameter to search for","required":false,"type":"string"},{"name":"max","in":"query","description":"Maximum number of results to return for each type, default 10","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiReviewer"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile/tables/{table}/rows":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get raw data samples from a job","description":"A random set of 10 rows are returned for all columns from a table.","operationId":"getJobSamplesUsingGET_4","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiSample"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile/tables/{table}/samples":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get raw data samples from a job","description":"Samples collected in a job can be fetched for a specified list of columms.","operationId":"getJobSamplesUsingGET_5","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"columnIds","in":"query","description":"A comma separated list of column IDs to fetch sample data for.","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"page","in":"query","description":"Page number if fetch, starting at 0","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Page size to fetch","required":false,"type":"integer","format":"int32"},{"name":"includeTags","in":"query","description":"includeTags","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiSample"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profile/tags":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to get all PII tags","description":"Use this interface to get a list of all PII tags found or added to a data model","operationId":"getTagsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiReviewer"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/profiler/fdm":{"get":{"tags":["results-controller-data-model"],"summary":"Interface to download a PII Job in FDM configuration format","description":"Fast Data Masker is a masking application, available for Windows and Linux. This API downloads the PII job in a format that is suitable to be imported into FDM to mask PII data.","operationId":"getAJobAsFDMConfigUsingGET_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"confirmedOnly","in":"query","description":"Include confirmed tables only","required":false,"type":"boolean"},{"name":"fileName","in":"query","description":"File name to be returned in content-disposition","required":false,"type":"string"},{"name":"excNotPii","in":"query","description":"Exclude tables marked as Not Pii","required":false,"type":"boolean"},{"name":"environmentId","in":"query","description":"Environment to be masked","required":true,"type":"integer","format":"int64"},{"name":"dataSources","in":"query","description":"Data sources to be masked","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"options","in":"query","description":"Options override","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/InputStreamResource"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permission to access the report.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"When this REST end point is down or not accessible.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Check logs for more information.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/datamodel/relationships":{"get":{"tags":["data-model-controller"],"summary":"Interface to get relationships for entities in a project version","operationId":"getRelationshipsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"q","in":"query","description":"Search criteria. TDM and RSQL format (see https://github.com/jirutka/rsql-parser ).Allows the query to be filtered on any of the resource's field values, such as 'parentEntityName' or 'childAttributName', etc.","required":false,"type":"string"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","default":20,"format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EntityRelationshipDetails"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["data-model-controller"],"summary":"Interface to add a relationships for entities and attributes","operationId":"createRelationshipUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"relationship","description":"Relationship details.","required":true,"schema":{"$ref":"#/definitions/EntityRelationshipDetails"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityRelationshipDetails"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/relationships/{relationshipId}":{"get":{"tags":["data-model-controller"],"summary":"Interface to get details for a single relationship in a project version","operationId":"getRelationshipUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"relationshipId","in":"path","description":"Relationship ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityRelationshipDetails"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["data-model-controller"],"summary":"Interface to post a relationships for entities and attributes","operationId":"updateRelationshipUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"relationshipId","in":"path","description":"Relationship ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"relationship","description":"Relationship details.","required":true,"schema":{"$ref":"#/definitions/EntityRelationshipDetails"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityRelationshipDetails"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["data-model-controller"],"summary":"Interface to delete a relationship for entities and attributes","operationId":"deleteRelationshipUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"relationshipId","in":"path","description":"Relationship ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityRelationshipDetails"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["data-model-controller"],"summary":"Interface to patch a relationships for entities and attributes","operationId":"patchRelationshipUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"relationshipId","in":"path","description":"Relationship ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"relationship","description":"Relationship details.","required":true,"schema":{"$ref":"#/definitions/EntityRelationshipDetails"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EntityRelationshipDetails"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/tables":{"get":{"tags":["object-controller"],"summary":"Interface for getting the tables to register from the current data model","description":"Use this interface to get the tables to register from the current data model","operationId":"getDataModelTablesUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project under which you want to get the tables. Need this for computing the differences","required":false,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version under which you want to get tables. Need this for computing the differences","required":false,"type":"integer","format":"int64"},{"name":"searchText","in":"query","description":"Search Text.","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number which you want to retrieve. default is 1","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Page size of each page. default is 25","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/TablesInfo"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}},"post":{"tags":["object-controller"],"summary":"Interface for exporting tables from the new data model to the legacy data model.","description":"Use this interface to copy tables and associated data from the new data model to the legacy data model","operationId":"postDataModelTablesUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"entityIds","description":"entityIds","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/ModelTableInfo"}}},{"name":"projectId","in":"query","description":"ID of the project under which you want to get the tables. Need this for computing the differences","required":false,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version under which you want to get tables. Need this for computing the differences","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/TablesInfo"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/datamodel/tags/maskConfigurations":{"get":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to get mask information from tags","description":"Use this interface to get the mask information from all PII tags.","operationId":"getAllTagMaskConfigGroupsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"q","in":"query","description":"Search criteria. RSQL format (see https://github.com/jirutka/rsql-parser ).Allows the query to be filtered e.g. on 'tagName'","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/MaskConfigGroupsByTag"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/tags/{tagId}/attributes/maskConfigurations":{"get":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to get masking group configuration for all attributes of a single tag","description":"Use this interface to get the masking group configuration for all attributes associated with a PII tag.","operationId":"getTagsAttributesMaskConfigurationsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/datamodel/tags/{tagId}/maskConfigurations":{"get":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to get mask information from a single tag","description":"Use this interface to get the mask information from a single PII tag.","operationId":"getSingleTagMaskConfigGroupsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to add a new masking configuration to current mask configurations associated with a PII tag for a project version","description":"Use this interface to add a new masking configuration to current mask configurations associated with a PII tag tag for a project version.","operationId":"postMaskConfigGroupToTagIdUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroup","description":"maskFunctionGroup","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroup"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to get masking group configuration from a single tag","description":"Use this interface to get the masking group configuration from a PII tag.","operationId":"putSingleTagMaskConfigGroupsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroup","description":"maskFunctionGroup","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroup"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to delete the mask group configuration for a tag","description":"Use this interface to delete the mask group configuration for all attributes assocaited with a PII tag.","operationId":"deleteSingleTagMaskConfigGroupsUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/tags/{tagId}/maskConfigurations/{groupId}":{"get":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to get masking group configuration from a single tag and group","description":"Use this interface to get the specific masking group configuration from a PII tag.","operationId":"getSingleTagMaskConfigGroupsByTagIdAndGroupIdUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"},{"name":"groupId","in":"path","description":"Group ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to put a new masking configuration group onto a single tag","description":"Use this interface to add a new masking configuration group to a PII tag.","operationId":"putSingleTagMaskConfigGroupsByTagIdAndGroupIdUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"},{"name":"groupId","in":"path","description":"Group ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroup","description":"maskFunctionGroup","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroup"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to delete a masking configuration on a tag","description":"Use this interface to delete a masking configuration group from a PII tag.","operationId":"deleteSingleTagMaskConfigGroupsByTagIdAndGroupIdUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"},{"name":"groupId","in":"path","description":"Group ID.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["mask-config-by-tag-controller"],"summary":"Interface to patch the masking function group information on a tag","description":"Use this interface to patch the specific masking group configuration on a PII tag.","operationId":"patchSingleTagMaskConfigGroupsByTagIdAndGroupIdUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"name":"tagId","in":"path","description":"Tag ID.","required":true,"type":"integer","format":"int64"},{"name":"groupId","in":"path","description":"Group ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"maskFunctionGroup","description":"maskFunctionGroup","required":true,"schema":{"$ref":"#/definitions/MaskFunctionGroup"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/MaskFunctionGroup"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/whereClauses":{"get":{"tags":["where-clause-controller"],"summary":"Interface to get a set of where clauses","description":"Use this interface to get set of where clauses for an attribute, mask function, or mask function group.","operationId":"getWhereClausesUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"attributeId","in":"query","description":"Attribute ID","required":false,"type":"integer","format":"int64"},{"name":"maskFunctionId","in":"query","description":"Mask Function ID.","required":false,"type":"integer","format":"int64"},{"name":"maskGroupId","in":"query","description":"Mask Function Group ID.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WhereClauseInfo"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["where-clause-controller"],"summary":"Interface to add a new where clause","description":"Use this interface to add a new where clause.","operationId":"postWhereClauseUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"whereClause","description":"whereClause","required":true,"schema":{"$ref":"#/definitions/WhereClauseInfo"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WhereClauseInfo"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["where-clause-controller"],"summary":"Interface to add a new where clause","description":"Use this interface to add a new where clause.","operationId":"postWhereClauseUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"whereClause","description":"whereClause","required":true,"schema":{"$ref":"#/definitions/WhereClauseInfo"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WhereClauseInfo"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/datamodel/whereClauses/{id}":{"get":{"tags":["where-clause-controller"],"summary":"Interface to get a specific where clause","description":"Use this interface to get a specific where clause.","operationId":"getWhereClauseUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":false,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WhereClauseInfo"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["where-clause-controller"],"summary":"Interface to get a specific where clause","description":"Use this interface to get a specific where clause.","operationId":"deleteWhereClauseUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"Project ID.","required":false,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/WhereClauseInfo"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/dbmd/{profileName}/schemas":{"get":{"tags":["object-controller"],"summary":"Interface for getting schemas associated with a connection profile","description":"Use this interface to retrieve the list of schemas for a given connection profile.","operationId":"getSchemasUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"profileName","in":"path","description":"Name of the connection profile for which you want to retrieve schemas.","required":true,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/jobs/{jobId}/start":{"post":{"tags":["job-controller"],"summary":"Interface to start a modeling service job from the Job Engine","operationId":"startJobUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"requestBody","description":"requestBody","required":true,"schema":{"$ref":"#/definitions/DBModellingParameters"}}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/objects":{"get":{"tags":["object-controller"],"summary":"Interface for getting objects","description":"Use this interface to retrieve the details of all the objects that belong to a specific project and project version.","operationId":"getObjectsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project for which you want to retrieve objects.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version for which you want to retrieve objects.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"type":"array","items":{"$ref":"#/definitions/ObjectDTO"}}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["object-controller"],"summary":"Interface for registering a new object","description":"Use this interface to register a new object. The following types of objects are supported: XML,XSD,WSDL,RRPAIR,JSON,TABLE and CSV.","operationId":"createObjectUsingPOST","consumes":["multipart/form-data"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project that you want to use to create a new object.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version that you want to use to create a new object.","required":true,"type":"integer","format":"int64"},{"name":"body","in":"formData","description":"body","required":true,"type":"ref"},{"name":"files","in":"formData","description":"List of files to be associate with the object you are creating.","required":false,"type":"array","items":{"type":"file"},"collectionFormat":"multi"},{"name":"requestFile","in":"formData","description":"Request file that you want to associate to the object that you are creating. This parameter is valid only for the RRPAIR type.","required":false,"type":"file"},{"name":"responseFile","in":"formData","description":"Response file that you want to associate to the object that you are creating. This parameter is valid only for the RRPAIR type.","required":false,"type":"file"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - Object with object name already exists.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message","schema":{"$ref":"#/definitions/ErrorResponse"}}}},"delete":{"tags":["object-controller"],"summary":"Interface for deleting objects in a version","description":"Use this interface to delete objects in a version.","operationId":"deleteObjectsInVersionUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project with the object that you want to delete is associated.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version with the object that you want to delete is associated.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform deleteObject operation asynchronously.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"204":{"description":"No Content - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/actions/delete":{"post":{"tags":["object-controller"],"summary":"Interface for deleting multiple objects","description":"Use this interface to delete multiple objects.","operationId":"deleteObjectsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"objectIds","description":"IDs of the objects that you want to delete.","required":true,"schema":{"$ref":"#/definitions/ObjectList"}},{"name":"projectId","in":"query","description":"ID of the project with the object that you want to delete is associated.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version with the object that you want to delete is associated.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform deleteObject operation asynchronously.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"201":{"description":"Created"},"204":{"description":"No Content - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}":{"get":{"tags":["object-controller"],"summary":"Interface for getting registered object details","description":"Use this interface to retrieve the details of a specific registered object.","operationId":"getObjectUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object that you want to use to get object details.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project that is associated to the object for which you want to get details.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version that is associated to the object for which you want to get details.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Object with ID not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}},"put":{"tags":["object-controller"],"summary":"Interface for modifying object attributes","description":"Use this interface to modify the attributes of an object which is already created.","operationId":"updateObjectUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object to be updated.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project under which the object is already created.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the version of the project under which the object is already created.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"object","description":"Object details.","required":true,"schema":{"$ref":"#/definitions/ObjectRequest"}}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - Object with object Name already exists.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}},"delete":{"tags":["object-controller"],"summary":"Interface for deleting objects","description":"Use this interface to delete a specific object.","operationId":"deleteObjectUsingDELETE","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object that you want to delete.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project with the object that you want to delete is associated.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version with the object that you want to delete is associated.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform deleteObject operation asynchronously.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"204":{"description":"No Content - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/deleteData":{"post":{"tags":["object-controller"],"summary":"Interface for deleting data in derived objects","description":"Use this interface to delete the data from derived objects. Derived objects are not deleted; only data is deleted.","operationId":"deleteDataUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project with which the object is registered.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version with which the object is registered.","required":true,"type":"integer","format":"int64"},{"name":"objectId","in":"path","description":"ID of the registered object for which you want to delete data in its derived objects.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform this operation asynchronously.","required":false,"type":"boolean"},{"name":"profileName","in":"query","description":"Name of the connection profile where the derived object from which you want to delete data is available.","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectEntriesEffected"}},"201":{"description":"Created"},"204":{"description":"No Content - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/derive":{"post":{"tags":["object-controller"],"summary":"Interface for creating and registering tables associated with a registered object","description":"Use this interface to derive and register tables associated with a registered object.","operationId":"createAndRegisterTablesUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object for which you want to create and register tables.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project under which you want to create and register tables.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version under which you want to create and register tables.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform this operation asynchronously.","required":false,"type":"boolean"},{"name":"rootElementName","in":"query","description":"Root element of the object that is used to create and register tables.","required":false,"type":"string"},{"name":"generateForiegnKeys","in":"query","description":"Set this attribute to true if you want to create foreign key constraints on the derived tables of the object.","required":false,"type":"boolean"},{"name":"reconcile","in":"query","description":"Set this attribute to true if you want to reconcile table conflicts created from the derived tables of the object.","required":false,"type":"boolean"},{"name":"tablePrefix","in":"query","description":"Prefix that you want to add to the names of the derived tables of the object. No default prefix value.","required":false,"type":"string"},{"name":"duplicateTableSuffix","in":"query","description":"Sufix that you want to add to the names of the duplicate tables of the object. Default sufix value.","required":false,"type":"string"},{"name":"cycleRecursionDepth","in":"query","description":"Level up to which you want to create tables in case of a cyclic references in the schema that the object creates. Its default value is 2 and maximum value is 32.","required":false,"type":"integer","format":"int32"},{"name":"wsdlOperation","in":"query","description":"Operation name for which tables have to be created if the object type is WSDL. It is mandatory if the object type is WSDL.","required":false,"type":"string"},{"name":"wsdlPortType","in":"query","description":"Port type for which you want to create tables if the object type is WSDL. If there are multiple operations of same name, port type has to be provided.","required":false,"type":"string"},{"name":"wsdlPortBinding","in":"query","description":"Port binding for which you want to create tables if the object type is WSDL. If there are multiple operations of same name, port binding has to be provided.","required":false,"type":"string"},{"name":"wsdlPortBindingNameSpace","in":"query","description":"Port binding namespace for which you want to create tables if the object type is WSDL. If there are conflicting port bindings of same name, port binding namespace has to be provided.","required":false,"type":"string"},{"name":"importObjectData","in":"query","description":"Set this attribute to true if you want to import the data after tables are created and registered. Valid only for XML, JSON, and RRPAIR object types.","required":false,"type":"boolean"},{"name":"documentGroupId","in":"query","description":"Document group ID of the imported records. This parameter is considered only if the importObjectData attribute is set to true.","required":false,"type":"string"},{"name":"rrPairLinkId","in":"query","description":"ID to map the request and response files of a request-response pair. Valid only for the RRPAIR object type.","required":false,"type":"string"},{"name":"allowComments","in":"query","description":"Set this attribute to true to allow the use of Java or C++ style comments (both '/'+'*' and '//' varieties) within the parsed content for a JSON object. Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"allowNonNumericValues","in":"query","description":"Set this attribute to true to recognize a set of Not-a-Number (NaN) tokens as valid floating number values for a JSON object. Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"allowNumericLeadingZeros","in":"query","description":"Set this attribute to true to allow JSON integral numbers to start with additional (ignorable) zeroes (for example, 005). Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"allowBackSlashEscaping","in":"query","description":"Set this attribute to true to allow the use of backslash to escape any character in JSON content. Valid for object of type JSON.Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"allowSingleQoutes","in":"query","description":"Set this attribute to true to allow the use of single quotes (apostrophe, character ''') for quoting strings (names and values). Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"allowUnqoutedControlChars","in":"query","description":"Set this attribute to true to allow JSON strings to contain unquoted control characters (ASCII characters with value less than 32, including tab and line feed characters). Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"allowUnqoutedFieldNames","in":"query","description":"Set this attribute to true to allow the use of unquoted field names (which is allowed by JavaScript, but not by JSON specification). Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"profileName","in":"query","description":"Name of the connection profile that identifies the database that you want to use to create derived tables.","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/export":{"post":{"tags":["object-controller"],"summary":"Interface to export data present in derived objects of a registered object in file formats supported by the registered object. This interface also updates the data to a virtual service","description":"Use this interface to export the data from derived objects (in the database) into supported file formats (XML and JSON). You can also use the interface to export the data into a virtual service for the RRPAIR type.","operationId":"exportDataFromDerivedObjectsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object that you want to use for the export operation.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project associated with the object that you want to use for the export operation.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version associated with the object that you want to use for the export operation.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform export operation asynchronously.","required":false,"type":"boolean"},{"name":"dataEncoding","in":"query","description":"Encoding format in which the files have to be exported.","required":false,"type":"string"},{"name":"documentGroupId","in":"query","description":"Document group ID used to perform export operation.","required":false,"type":"string"},{"name":"rrPairLinkId","in":"query","description":"RRPair link ID used to perform export operation.","required":false,"type":"string"},{"name":"profileName","in":"query","description":"Name of the connection profile that you want to use for the export operation.","required":false,"type":"string"},{"name":"schemaName","in":"query","description":"Name of the schema in the connection profile that you want to use for the import operation.","required":false,"type":"string"},{"name":"exportIntoMultipleFiles","in":"query","description":"Set this attribute to true if you want to export the data into multiple files or else set it to false if you want to export the data into a single file. By default, it is exported to multiple files.","required":false,"type":"boolean"},{"name":"baseFileName","in":"query","description":"Base file name of the files that are generated as a result of the export operation. Default value is CATDM.","required":false,"type":"string"},{"name":"elementNameForSuffix","in":"query","description":"Specifies the metadata that is used in the name of the exported XML document. This value must be a name of an element in the exported XML. For example, If you want to use the first name (<firstname>John</firstname>) as a suffix, provide firstname without quotes. The exported document then includes John in its name as <baseFileName>_<documentGroupId>_John.xml.","required":false,"type":"string"},{"name":"requireDataIndentation","in":"query","description":"Set this attribute to false if you do not want to indent the XML data while exporting. By default it is true.","required":false,"type":"boolean"},{"name":"includeXmlDeclaration","in":"query","description":"Set this attribute to false if you do not want to include the XML declaration in the exported XML files.","required":false,"type":"boolean"},{"name":"includeStandaloneAttribute","in":"query","description":"Set this attribute to true to set the standalone attribute to true in the exported XML files. It will take affect only if includeXmlDeclaration is set to true.","required":false,"type":"boolean"},{"name":"honorUnqualifiedForms","in":"query","description":"Set this attribute to false if you do not want to honor the unqualified form for elements in exported XML files. By default, it is true.","required":false,"type":"boolean"},{"name":"escapeNonASCII","in":"query","description":"Set this attribute to true to specify that all characters beyond 7-bit ASCII range (that is, code points of 128 and above) must be exported using format-specific escapes. Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"quoteFieldNames","in":"query","description":"Set this attribute to false if you do not want to quote JSON field names using double quotes, as specified by JSON specification. By default, it is true. Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"quoteNonNumerics","in":"query","description":"Set this attribute to false if you do not want to output exceptional (not real number) float/double values as strings using double quotes. By default, it is true. Valid only for the JSON object type.","required":false,"type":"boolean"},{"name":"writeNumbersAsStrings","in":"query","description":"Set this attribute to true to write all Java numbers as JSON strings. By default, it is false. Valid for object of type JSON only.","required":false,"type":"boolean"},{"name":"prettyPrintJSON","in":"query","description":"Set this attribute to false if you do not want to format the exported JSON files for better readability. By default, it is true. Valid for object of type JSON only.","required":false,"type":"boolean"},{"name":"updateVirtualService","in":"query","description":"Set this attribute to true in order to update virtual service by importing the exported request and response documents into CA Service Virtualization. Valid for object of types WSDL and RRPAIR only.","required":false,"type":"boolean"},{"name":"virtualServiceEnvironment","in":"query","description":"Virtual service environment that contains the virtual service.","required":false,"type":"string"},{"name":"virtualService","in":"query","description":"Virtual service to update.","required":false,"type":"string"},{"name":"publishFiles","in":"query","description":"Set this attribute to true to perform the publish operation before the export operation.","required":false,"type":"boolean"},{"name":"generatorId","in":"query","description":"Generator ID of the data generator that you want to use for the publish operation. This parameter is applicable only when the publishFiles parameter is set to true.","required":false,"type":"string"},{"name":"noOfFiles","in":"query","description":"Number of times you want to repeat the publish operation. This parameter is applicable when publishFiles is set to true.","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"type":"object"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/getRowCount":{"post":{"tags":["object-controller"],"summary":"Interface for getting the the data row count of data for tables associated with a registered object","description":"Use this interface to get the data row count of data of a registered object.","operationId":"getRowCountUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project associated with the registered object for which you want to find the row count.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version associated with the registered object for which you want to find the row count.","required":true,"type":"integer","format":"int64"},{"name":"schemaName","in":"query","description":"Name of the schema in the connection profile that you want to use for the import operation.","required":false,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object for which you want to find the row count.","required":true,"type":"integer","format":"int64"},{"name":"profileName","in":"query","description":"Connection profile name where the tables are present for which you want to determine the row count for a registered object.","required":true,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectEntriesEffected"}},"201":{"description":"Created"},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/getroots":{"post":{"tags":["object-controller"],"summary":"Interface to retrieve roots defined in registered objects","description":"Use this interface to retrieve the root elements defined in a registered object.","operationId":"getRootElementsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object for which you want to find the root elements.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project associated with the object for which you want to find the root elements.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version associated with the object for which you want to find the root elements.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/RootElementBean"}},"201":{"description":"Created"},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/import":{"post":{"tags":["object-controller"],"summary":"Interface for performing import data action on registered objects","description":"Use this interface to import the data into derived objects of a registered object.","operationId":"importDataUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the object for which you want to perform the import operation.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project associated with the object for which you want to perform the import operation.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version associated with the object for which you want to perform the import operation.","required":true,"type":"integer","format":"int64"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform import data operation asynchronously.","required":false,"type":"boolean"},{"name":"dataEncoding","in":"query","description":"Encoding format of the file using which you want to perform the import operation. Standard character sets include US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE, UTF-16. Default value is UTF-8.","required":false,"type":"string"},{"name":"documentGroupId","in":"query","description":"Document group ID of the imported documents.","required":false,"type":"string"},{"name":"rrPairLinkId","in":"query","description":"ID to map the request and response files of a request-response pair. Valid only for the RRPAIR object type.","required":false,"type":"string"},{"name":"schemaName","in":"query","description":"Name of the schema in the connection profile that you want to use for the import operation.","required":false,"type":"string"},{"name":"profileName","in":"query","description":"Name of the connection profile that you want to use for the import operation.","required":false,"type":"string"},{"name":"files","in":"formData","description":"List of XML and JSON files to be imported for objects of type XSD,XML and JSON types respectively.","required":false,"type":"array","items":{"type":"file"},"collectionFormat":"multi"},{"name":"requestFiles","in":"formData","description":"List of request XML or JSON files to be imported. Only valid for RRPAIR and WSDL type of object.","required":false,"type":"array","items":{"type":"file"},"collectionFormat":"multi"},{"name":"responseFiles","in":"formData","description":"List of response XML or JSON files to be imported. Only valid for RRPAIR and WSDL type of object.","required":false,"type":"array","items":{"type":"file"},"collectionFormat":"multi"},{"name":"importToGenerator","in":"query","description":"Set this attribute to true if you also want to import the data into the data generator.","required":false,"type":"boolean"},{"name":"generatorId","in":"query","description":"ID of the data generator into which you want to import the data. This parameter is applicable only when you set importToGenerator to true.","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/actions/unRegister":{"post":{"tags":["object-controller"],"summary":"Interface for unregistering and dropping derived objects associated with a registered object","description":"Use this interface to unregister and drop derived objects associated with a registered object.","operationId":"unRegisterUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project with which the derived object that you want to drop is registered.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version with which the derived object that you want to drop is registered.","required":true,"type":"integer","format":"int64"},{"name":"objectId","in":"path","description":"ID of the registered object for which you want to drop derived objects.","required":true,"type":"integer","format":"int64"},{"name":"dropTables","in":"query","description":"Set the attribute to true if you want to drop tables after unregistering them.","required":false,"type":"boolean"},{"name":"profileName","in":"query","description":"Name of the connection profile from where you want to drop the derived objects.","required":false,"type":"string"},{"name":"async","in":"query","description":"Set this attribute to true if you want to perform this operation asynchronously.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/objects/{objectId}/derivedObjects":{"get":{"tags":["object-controller"],"summary":"Interface for getting details of derived objects associated with a registered object","description":"Use this interface to retrieve the list of derived objects associated with a registered object.","operationId":"getDerivedObjectsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the registered object for which you want to get the list of associated derived objects.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project associated with the registered object for which derived objects are already created.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version associated with the registered object for which derived objects are already created.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/objects/{objectId}/derivedObjects/{derivedObjectId}":{"get":{"tags":["object-controller"],"summary":"Interface for getting details of a derived object","description":"Use this interface to retrieve the details of a derived object associated with a registered object.","operationId":"getDerivedObjectUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"objectId","in":"path","description":"ID of the registered object that is associated with the derived object for which you want to get the details.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project associated with the registered object that is related to the derived object for which you want to get the details.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version associated with the registered object that is related to the derived object for which you want to get the details.","required":true,"type":"integer","format":"int64"},{"name":"derivedObjectId","in":"path","description":"ID of the derived object for which you want to get the details.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/ObjectDTO"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/profiler/classifiers":{"post":{"tags":["classifier-controller"],"summary":"Interface to import classifier definitions","description":"Use this interface to import classifier definitions. Definitions should be packaged in zip file.","operationId":"importClassifiersUsingPOST","consumes":["multipart/form-data"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"definitionsFile","in":"formData","description":"Zip file containing classifier hierarchy definition to be imported.","required":false,"type":"file"},{"name":"parentId","in":"query","description":"container where the definitions should be imoprted.","required":false,"type":"integer","format":"int64"},{"name":"onduplicate","in":"query","description":"defines behaviour during import, if a duplicate resource is found what to do. (ignore, abort, overwrite)","required":false,"type":"string"},{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ImportClassifierResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/classifiers/classifiers":{"post":{"tags":["classifier-controller"],"summary":"Interface for creating a classifier","operationId":"createClassifierUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"classifier","description":"classifier","required":true,"schema":{"$ref":"#/definitions/Classifier"}},{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Classifier"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/classifiers/classifiers/{classifierId}":{"get":{"tags":["classifier-controller"],"summary":"Interface for getting the list of classifiers and containers which are children of a container specified by classifierId.","operationId":"getClassifierUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"classifierId","in":"path","description":"classifierId","required":true,"type":"integer","format":"int64"},{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Classifier"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["classifier-controller"],"summary":"Interface for modifying a classifier","operationId":"modifyClassifierUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"classifier","description":"classifier","required":true,"schema":{"$ref":"#/definitions/Classifier"}},{"name":"classifierId","in":"path","description":"classifierId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Classifier"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["classifier-controller"],"summary":"Interface for deleting a classifier","operationId":"deleteClassifierUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"classifierId","in":"path","description":"classifierId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/classifiers/containers/{containerId}":{"get":{"tags":["classifier-controller"],"summary":"Interface for getting the container details","operationId":"getContainerUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"containerId","in":"path","description":"containerId","required":true,"type":"integer","format":"int64"},{"name":"recursive","in":"query","description":"recursive","required":false,"type":"integer","format":"int64"},{"name":"classifierType","in":"query","description":"classifierType","required":false,"type":"string"},{"name":"classifierClass","in":"query","description":"classifierClass","required":false,"type":"string"},{"name":"classifierOrigin","in":"query","description":"classifierOrigin","required":false,"type":"string"},{"name":"tags","in":"query","description":"tags","required":false,"type":"string"},{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClassifierContainer"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["classifier-controller"],"summary":"Interface for updating a container","operationId":"modifyContainerUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"container","description":"container","required":true,"schema":{"$ref":"#/definitions/DBClassifierContainer"}},{"name":"containerId","in":"path","description":"containerId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClassifierContainer"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["classifier-controller"],"summary":"Interface for deleting a container","operationId":"deleteContainerUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"containerId","in":"path","description":"containerId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/classifiers/containers/{parentId}":{"post":{"tags":["classifier-controller"],"summary":"Interface for creating a container","operationId":"createContainerUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"in":"body","name":"container","description":"container","required":true,"schema":{"$ref":"#/definitions/DBClassifierContainer"}},{"name":"parentId","in":"path","description":"parentId","required":true,"type":"integer","format":"int64"},{"name":"Accept-Language","in":"query","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClassifierContainer"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/classifiers/containersclassifiers":{"delete":{"tags":["classifier-controller"],"summary":"Interface for deleting a container","operationId":"deleteContainersClassifiersUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"ids","in":"query","description":"a list of containers and classifiers to be deleted. CXXX,MXXX,...","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/classifiers/snapshot/classifiers/{snapshotHash}":{"get":{"tags":["classifier-controller"],"summary":"Interface for getting the snapshot classifier definition by hash code","operationId":"getClassifierSnapshotUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"snapshotHash","in":"path","description":"snapshotHash","required":true,"type":"integer","format":"int32"},{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DBClassifier"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/classifiers/snapshot/seedlists/{snapshotHash}":{"get":{"tags":["classifier-controller"],"summary":"Interface for getting the snapshot seedlist definitions by hash code","operationId":"getSeedlistSnapshotUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"snapshotHash","in":"path","description":"snapshotHash","required":true,"type":"integer","format":"int32"},{"name":"Accept-Language","in":"header","description":"Accept-Language","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/SeedListSnapshot"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/classifiers/status":{"get":{"tags":["classifier-controller"],"summary":"getClassifierStatus","operationId":"getClassifierStatusUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ClassifierStatusResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs":{"get":{"tags":["results-controller"],"summary":"Interface to get the profiling jobs","operationId":"getJobsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"projectId","required":false,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"versionId","required":false,"type":"integer","format":"int64"},{"name":"state","in":"query","description":"state","required":false,"type":"array","items":{"type":"string","enum":["CREATED","STARTED","CANCELLING","CANCELLED","SCAN_COMPLETE","APPROVAL_REQUIRED","APPROVED","APPROVAL_REJECTED","FAILED","SIGNED_OFF","SIGN_OFF_REJECTED"]},"collectionFormat":"multi","enum":["CREATED","STARTED","CANCELLING","CANCELLED","SCAN_COMPLETE","APPROVAL_REQUIRED","APPROVED","APPROVAL_REJECTED","FAILED","SIGNED_OFF","SIGN_OFF_REJECTED"]}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiJob"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/":{"delete":{"tags":["results-controller"],"summary":"Interface to delete all profiling jobs for a particular project and version","operationId":"deleteJobsUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"Project ID to delete","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"Project version ID to delete","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{jobId}/start":{"post":{"tags":["profiler-controller"],"summary":"Interface to start a PII profiling job from the Job Engine","operationId":"startProfilingJobUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"jobId","in":"path","description":"jobId","required":true,"type":"string"},{"in":"body","name":"requestBody","description":"requestBody","required":true,"schema":{"$ref":"#/definitions/PIIScanParameters"}},{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}":{"get":{"tags":["results-controller"],"summary":"Interface to get a single job","operationId":"getAJobUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiJob"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["results-controller"],"summary":"Interface to delete a profiling job","operationId":"deleteJobUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiJob"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["results-controller"],"summary":"Interface to set the review state for a job","operationId":"patchAJobUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiJob"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiJob"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{job}/fdm":{"get":{"tags":["results-controller"],"summary":"Interface to download a PII Job in FDM configuration format","description":"Fast Data Masker is a masking application, available for Windows and Linux. This API downloads the PII job in a format that is suitable to be imported into FDM to mask PII data.","operationId":"getAJobAsFDMConfigUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"confirmedOnly","in":"query","description":"Include confirmed tables only","required":false,"type":"boolean"},{"name":"fileName","in":"query","description":"File name to be returned in content-disposition","required":false,"type":"string"},{"name":"excNotPii","in":"query","description":"Exclude tables marked as Not Pii","required":false,"type":"boolean"},{"name":"environmentId","in":"query","description":"Environment to be masked","required":true,"type":"integer","format":"int64"},{"name":"dataSources","in":"query","description":"Data sources to be masked","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"options","in":"query","description":"Options override","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/InputStreamResource"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permission to access the configuration.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"When this REST end point is down or not accessible.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Check logs for more information.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/profiler/jobs/{job}/piidata":{"get":{"tags":["results-controller"],"summary":"Interface to get the PII data for a job","description":"Returns potential PII data for a job a page at a time.","operationId":"getAJobsPiiDataUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"Page number if fetch, starting at 0","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Page size to fetch","required":false,"type":"integer","format":"int32"},{"name":"hasTags","in":"query","description":"Include columns with PII only ?","required":false,"type":"boolean"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"name":"q","in":"query","description":"Query parameter to search tags:, tables:, columns:, schema:, profile: or all of those","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiData"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/piidata/{table}":{"get":{"tags":["results-controller"],"summary":"Interface to get the PII data for a single table","operationId":"getAJobsPiiDataForOneTableUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiData"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["results-controller"],"summary":"Interface to patch the PII data for a table","description":"Use this interface to either accept, reject or alter the PII data for a table","operationId":"patchAJobPiiDataUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiData"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiData"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{job}/piidata/{table}/columns":{"get":{"tags":["results-controller"],"summary":"Interface to get the PII data for all columms in a table","operationId":"getAJobsPiiDataForOneTableAndColumnsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","format":"int32"},{"name":"hasTags","in":"query","description":"Include columns with PII only ?","required":false,"type":"boolean"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["results-controller"],"summary":"Interface to put or patch the PII data for several columns in a table","description":"Use this interface to either add or remove PII tags for several columns in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndManyColumnsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["results-controller"],"summary":"Interface to put or patch the PII data for several columns in a table","description":"Use this interface to either add or remove PII tags for several columns in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndManyColumnsUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{job}/piidata/{table}/columns/{column}":{"put":{"tags":["results-controller"],"summary":"Interface to put or patch the PII data for a single columm in a table","description":"Use this interface to either add or remove PII tags for a single column in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndColumnsUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"column","in":"path","description":"column","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiDataColumn"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["results-controller"],"summary":"Interface to put or patch the PII data for a single columm in a table","description":"Use this interface to either add or remove PII tags for a single column in a table. Use an Action of REMOVE to remove tags on a PUT call. An action of ADD is implicit on a PATCH.","operationId":"patchAJobsPiiDataForOneTableAndColumnsUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"column","in":"path","description":"column","required":true,"type":"integer","format":"int64"},{"name":"history","in":"query","description":"Include tag history in output, default is false","required":false,"type":"boolean"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiDataColumn"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{job}/profiles":{"get":{"tags":["results-controller"],"summary":"Interface to get the connection profiles","description":"Returns the connection profiles used in this profiling job","operationId":"getAJobsProfilesUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConnectionProfile"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/report":{"get":{"tags":["results-controller"],"summary":"Interface to download a PII Job report in PDF format","description":"For report class DRAFT, the report is generated on the fly. For TDE, AUDITOR or MANAGEMENT, the report is retrieved from the repository.","operationId":"getAJobAsPdfUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"fileName","in":"query","description":"File name to be returned in content-disposition","required":false,"type":"string"},{"name":"reportClass","in":"query","description":"Report class: DRAFT, TDE, AUDITOR or MANAGEMENT","required":true,"type":"string"},{"name":"format","in":"query","description":"Format of the report document","required":true,"type":"string","default":"pdf","enum":["pdf"]}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/InputStreamResource"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permission to access the report.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"When this REST end point is down or not accessible.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Check logs for more information.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/profiler/jobs/{job}/reportGen":{"post":{"tags":["results-controller"],"summary":"Interface to create and store PII Job reports in the repository","description":"If the report class is not specified, all three of TDE, MANAGEMENT and AUDITOR reports will be generated.","operationId":"reportCreateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"reportClass","in":"query","description":"Report class: TDE, AUDITOR or MANAGEMENT","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/InputStreamResource"}},"201":{"description":"Created"},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permission to access the report.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"When this REST end point is down or not accessible.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Check logs for more information.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/profiler/jobs/{job}/reportInfo":{"get":{"tags":["results-controller"],"summary":"Interface to retrieve information about a PII report","description":"Information retrieved excludes the PDF report.","operationId":"getReportInfoUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"reportClass","in":"query","description":"Report class: DRAFT, TDE, AUDITOR or MANAGEMENT","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/DBPiiReport"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permission to access the report.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"When this REST end point is down or not accessible.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Check logs for more information.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/profiler/jobs/{job}/reviewers":{"get":{"tags":["results-controller"],"summary":"Interface to get the reviewers of a project","operationId":"getJobReviewersUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiReviewer"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["results-controller"],"summary":"Interface to add a reviewer to a project.","description":"The user ID and user name are required.","operationId":"postjobReviewerUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"in":"body","name":"post","description":"post","required":true,"schema":{"$ref":"#/definitions/PiiReviewer"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiReviewer"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/reviewers/{id}":{"get":{"tags":["results-controller"],"summary":"Interface to get a specific reviewer for a project","operationId":"getAJobReviewerUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"id","in":"path","description":"id","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiReviewer"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/reviewers/{reviewer}":{"delete":{"tags":["results-controller"],"summary":"Interface to remove a reviewer from a job","operationId":"deleteJobReviewerUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"reviewer","in":"path","description":"reviewer","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["results-controller"],"summary":"Interface to update a reviewers input for a job","description":"Used this interface to accept or reject the PII classification of a job.","operationId":"patchjobReviewerUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"reviewer","in":"path","description":"reviewer","required":true,"type":"integer","format":"int64"},{"in":"body","name":"patch","description":"patch","required":true,"schema":{"$ref":"#/definitions/PiiReviewer"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiReviewer"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{job}/samples":{"get":{"tags":["results-controller"],"summary":"Interface to return total samples stored for ","description":"Samples collected in a job can be fetched for a specified list of columms.","operationId":"getJobSamplesUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"object"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["results-controller"],"summary":"Interface to delete stored samples from a job","operationId":"deleteJobSamplesUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/jobs/{job}/tables":{"get":{"tags":["results-controller"],"summary":"Interface to get the tables discovered in this job","operationId":"getJobTablesUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","format":"int32"},{"name":"q","in":"query","description":"Query parameter to search for","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiTable"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/tables/{table}":{"get":{"tags":["results-controller"],"summary":"Interface to get details of a single table in a job","operationId":"getJobOneTableUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiTable"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/tables/{table}/rows":{"get":{"tags":["results-controller"],"summary":"Interface to get raw data samples from a job","description":"A random set of 10 rows are returned for all columns from a table.","operationId":"getJobSamplesUsingGET_1","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiSample"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/jobs/{job}/tables/{table}/samples":{"get":{"tags":["results-controller"],"summary":"Interface to get raw data samples from a job","description":"Samples collected in a job can be fetched for a specified list of columms.","operationId":"getJobSamplesUsingGET_2","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"table","in":"path","description":"table","required":true,"type":"integer","format":"int64"},{"name":"columnIds","in":"query","description":"A comma separated list of column IDs to fetch sample data for.","required":false,"type":"array","items":{"type":"integer","format":"int64"},"collectionFormat":"multi"},{"name":"page","in":"query","description":"Page number if fetch, starting at 0","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Page size to fetch","required":false,"type":"integer","format":"int32"},{"name":"includeTags","in":"query","description":"includeTags","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PiiSample"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/search/{job}":{"get":{"tags":["results-controller"],"summary":"Interface to update a reviewers input for a job","description":"Used this interface to accept or reject the PII classification of a job.","operationId":"searchUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"job","in":"path","description":"job","required":true,"type":"integer","format":"int64"},{"name":"q","in":"query","description":"Query parameter to search for","required":false,"type":"string"},{"name":"max","in":"query","description":"Maximum number of results to return for each type, default 10","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiReviewer"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/setup":{"get":{"tags":["profiler-controller"],"summary":"Interface to get the profiler setup for the specified project and version","description":"Returns a default (empty) setup if no profiler setup exists for the specified project id and version id.","operationId":"getProfilerSetupUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"projectId","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"versionId","required":true,"type":"integer","format":"int64"},{"name":"origin","in":"query","description":"origin","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiSetup"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["profiler-controller"],"summary":"Interface to delete the profiler setup for the specified project and version","description":"Returns 404 Not Found if the record does not exist for the specified project id and version id.","operationId":"deleteProfilerSetupUsingDELETE","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"projectId","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"versionId","required":true,"type":"integer","format":"int64"},{"name":"origin","in":"query","description":"origin","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PiiSetup"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["profiler-controller"],"summary":"Interface to update the list of connection profile names for a profiler setup","description":"The profiler setup will be created if one doesn't already exist for the specified project id and version id.","operationId":"updateSetupUsingPATCH","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"projectId","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"versionId","required":true,"type":"integer","format":"int64"},{"name":"origin","in":"query","description":"origin","required":false,"type":"string"},{"in":"body","name":"setup","description":"setup","required":true,"schema":{"$ref":"#/definitions/PiiSetup"}}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/api/ca/v1/profiler/tags":{"get":{"tags":["tags-controller"],"summary":"Interface to get list of tags","operationId":"getPagedTagsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"page","in":"query","description":"The page of data to request, starting from 0.","required":false,"type":"integer","default":0,"format":"int32"},{"name":"size","in":"query","description":"The size of the page of data to request.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"q","in":"query","description":"Search criteria. RSQL format (see https://github.com/jirutka/rsql-parser ).Allows the query to be filtered on any of the resource's field values, such as 'id' or 'name', etc.","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/DBPiiTag"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/profiler/tags/{tagId}":{"get":{"tags":["tags-controller"],"summary":"Interface to get tag information for a given tag id","operationId":"getTagUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"tagId","in":"path","description":"tagId","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DBPiiTag"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/projects/{projectId}/versions/{versionId}/actions/calculateTableOrder":{"post":{"tags":["object-controller"],"summary":"Interface for Creating Table Order","description":"Use this interface for Creating Table Order.","operationId":"calculateTableOrderUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"path","description":"ID of the project you want to calculate table order.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"path","description":"ID of the project version associated with the registered table for which you want to retrieve the columns.","required":true,"type":"integer","format":"int64"},{"in":"body","name":"tableOrderRequest","description":"Table Order Additional options.","required":false,"schema":{"$ref":"#/definitions/TableOrderRequest"}}],"responses":{"200":{"description":"Success.","schema":{"type":"array","items":{"$ref":"#/definitions/ObjectDTO"}}},"201":{"description":"Created"},"202":{"description":"Cycles are found while calculating Table Order select any one or more of the relations which need to be ignored.","schema":{"$ref":"#/definitions/CyclicRelations"}},"204":{"description":"No Content - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/projects/{projectId}/versions/{versionId}/dataGenerators":{"get":{"tags":["object-controller"],"summary":"Interface for getting data generators for a given user, project, and project version","description":"Use this interface to retrieve the list of data generators for a given user, project, and project version.","operationId":"getDataGeneratorsUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"path","description":"ID of the project for which you want to retrieve data generators.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"path","description":"ID of the project version for which you want to retrieve data generators.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"type":"array","items":{"$ref":"#/definitions/GeneratorInfo"}}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/ca/v1/registeredTables":{"get":{"tags":["object-controller"],"summary":"Interface for getting all the tables registered with a project version","description":"Use this interface to retrieve the list of registered tables for a project version.","operationId":"getRegisteredTablesUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project for which you want to retrieve registered tables.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the version for which you want to retrieve registered tables.","required":true,"type":"integer","format":"int64"},{"name":"pageNum","in":"query","description":"Page number that you want to retrieve in the paginated result. Default value is 1.","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"Page size of each page that you want to retrieve in the paginated result. Default value is 1000000.","required":false,"type":"integer","format":"int32"},{"name":"searchText","in":"query","description":"Search text that you want to use to filter the registered tables.","required":false,"type":"string"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/PaginatedResult"}},"400":{"description":"Bad Request - Request does not have a valid format or has missing required parameters.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized - Invalid or expired token.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permissions to access the resource.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Not Found - Resource not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/registeredTables/{tableId}":{"get":{"tags":["object-controller"],"summary":"Interface for getting the registered table details","description":"Use this interface to retrieve the registered table details.","operationId":"getRegisteredTableDetailsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"tableId","in":"path","description":"ID of the table for which you want to retrieve the details.","required":true,"type":"integer","format":"int64"},{"name":"projectId","in":"query","description":"ID of the project to which the registered table belongs.","required":true,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the version to which the registered table belongs.","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/TableDetails"}},"400":{"description":"Bad Request - Request does not have a valid format or has missing required parameters.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized - Invalid or expired token.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden - User does not have permissions to access the resource.","schema":{"$ref":"#/definitions/ErrorResponse"}},"404":{"description":"Not Found - Resource not found.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}},"/api/ca/v1/tables":{"get":{"tags":["object-controller"],"summary":"Interface for getting the tables under a schema","description":"Use this interface to get the tables under the schema","operationId":"getTablesUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Use the /user/login interface to perform a user login using user credentials in the Basic HTTP authorization scheme. The API responds with a security token, which is valid for 24 hours by default. Use the security token in the Bearer HTTP authorization scheme to access any protected resource through this API on behalf of the user. For Example: Bearer {{token}}","required":true,"type":"string"},{"name":"projectId","in":"query","description":"ID of the project under which you want to get the tables. Need this for computing the differences","required":false,"type":"integer","format":"int64"},{"name":"versionId","in":"query","description":"ID of the project version under which you want to get tables. Need this for computing the differences","required":false,"type":"integer","format":"int64"},{"name":"schema","in":"query","description":"Name of the table location from which you want to get tables.","required":true,"type":"string"},{"name":"profileName","in":"query","description":"Name of the connection profile that identifies the database from where you register the tables.","required":false,"type":"string"},{"name":"searchText","in":"query","description":"Search Text.","required":false,"type":"string"},{"name":"page","in":"query","description":"Page number which you want to retrieve. default is 1","required":false,"type":"integer","format":"int32"},{"name":"size","in":"query","description":"Page size of each page. default is 25","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Success.","schema":{"$ref":"#/definitions/TablesInfo"}},"400":{"description":"Bad Request - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Server authentication failed.","schema":{"$ref":"#/definitions/ErrorResponse"}},"403":{"description":"Forbidden"},"404":{"description":"Not Found - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"409":{"description":"Conflict - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}},"500":{"description":"Internal Server Error - Specific reason is included in the error message.","schema":{"$ref":"#/definitions/ErrorResponse"}}}}}},"definitions":{"AttribMaskFunctionGroup":{"type":"object","properties":{"attributeId":{"type":"integer","format":"int64"},"attributeName":{"type":"string"},"classifierBased":{"type":"boolean"},"dataSource":{"type":"string"},"dataType":{"type":"string"},"databaseName":{"type":"string"},"entityName":{"type":"string"},"hasWhereClause":{"type":"boolean"},"maskGroupId":{"type":"integer","format":"int64"},"maskGroupLabel":{"type":"string"},"maskGroupShared":{"type":"boolean"},"numOtherTags":{"type":"integer","format":"int64"},"primaryTag":{"type":"string"},"schemaName":{"type":"string"}}},"Classifier":{"type":"object","properties":{"classifierClass":{"type":"string"},"classifierOrigin":{"type":"string"},"classifierType":{"type":"string"},"config":{"type":"array","items":{"$ref":"#/definitions/DBClassifierConfig"}},"created":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"description":{"type":"string"},"descriptions":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"id":{"type":"integer","format":"int64"},"maskFunction":{"type":"array","items":{"$ref":"#/definitions/DBMaskFunction"}},"maskFunctionGroup":{"type":"array","items":{"$ref":"#/definitions/DBMaskFunctionGroup"}},"name":{"type":"string"},"names":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"parentId":{"type":"integer","format":"int64"},"tagId":{"type":"integer","format":"int64"},"tags":{"type":"string"},"updated":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}}},"ClassifierContainer":{"type":"object","properties":{"containedClassifiers":{"type":"array","items":{"$ref":"#/definitions/DBClassifier"}},"containedContainers":{"type":"array","items":{"$ref":"#/definitions/DBClassifierContainer"}},"created":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"description":{"type":"string"},"descriptions":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"names":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"parentId":{"type":"integer","format":"int64"},"root":{"type":"boolean"},"updated":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}}},"ClassifierStatusResponse":{"type":"object","properties":{"importing":{"type":"boolean"}}},"ColumnDetails":{"type":"object","properties":{"dataType":{"type":"string","description":"Datatype of the column"},"defaultValue":{"type":"string"},"id":{"type":"integer","format":"int64","description":"ID of the column","readOnly":true},"isNullable":{"type":"string","description":"Nullable column"},"name":{"type":"string","description":"Name of the column"},"precision":{"type":"integer","format":"int64","description":"Precision for a column"},"scale":{"type":"integer","format":"int64","description":"Scale for a column"},"sequence":{"type":"integer","format":"int64","description":"Sequential number of the column"}}},"ConnectionProfile":{"type":"object","required":["dbType","name","password","server","username"],"properties":{"additionalConnectionProperties":{"type":"string","description":"JDBC connection string properties. Applicable only for database type db2/400 sql"},"created":{"type":"string","format":"date-time","description":"Creation date"},"createdBy":{"type":"integer","format":"int64","description":"Created by"},"database":{"type":"string","description":"Database name"},"datasourceDriver":{"type":"string","description":"DataSource Driver"},"datasourceUrl":{"type":"string","description":"DataSource URL"},"dbType":{"type":"string","description":"Type of database","enum":["sql server","oracle","mysql","sybase","teradata","db2","db2/400 sql"]},"description":{"type":"string","description":"Descriptive text"},"instance":{"type":"string","description":"Sql server instance name"},"integratedSecurity":{"type":"boolean","example":false,"description":"Use Integrated Security for authentication. Applicable only for database type SQL Server"},"modified":{"type":"string","format":"date-time","description":"Last modified date"},"name":{"type":"string","description":"Name of the connection profile"},"password":{"type":"string","description":"Password"},"port":{"type":"string","description":"Database server port"},"schema":{"type":"string","description":"Sql server schema name"},"server":{"type":"string","description":"Database server hostname"},"service":{"type":"string","description":"Oracle service name"},"username":{"type":"string","description":"Username"}}},"CyclicRelations":{"type":"object","properties":{"foreignKeys":{"type":"array","items":{"$ref":"#/definitions/ForeignKeyDetails"}},"message":{"type":"string"},"relationships":{"type":"array","items":{"$ref":"#/definitions/RelationshipDetails"}}}},"DBClassifier":{"type":"object","properties":{"classifierClass":{"type":"string"},"classifierOrigin":{"type":"string"},"classifierType":{"type":"string"},"config":{"type":"array","items":{"$ref":"#/definitions/DBClassifierConfig"}},"created":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"description":{"type":"string"},"descriptions":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"id":{"type":"integer","format":"int64"},"maskFunction":{"type":"array","items":{"$ref":"#/definitions/DBMaskFunction"}},"maskFunctionGroup":{"type":"array","items":{"$ref":"#/definitions/DBMaskFunctionGroup"}},"name":{"type":"string"},"names":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"tagId":{"type":"integer","format":"int64"},"tags":{"type":"string"},"updated":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}}},"DBClassifierConfig":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"value":{"type":"string"}}},"DBClassifierContainer":{"type":"object","properties":{"containedClassifiers":{"type":"array","items":{"$ref":"#/definitions/DBClassifier"}},"containedContainers":{"type":"array","items":{"$ref":"#/definitions/DBClassifierContainer"}},"created":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"description":{"type":"string"},"descriptions":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"names":{"type":"array","items":{"$ref":"#/definitions/DBClassifierString"}},"root":{"type":"boolean"},"updated":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}}},"DBClassifierString":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"lang":{"type":"string"},"value":{"type":"string"}}},"DBDataDiscoveryEntityAttrDef":{"type":"object","properties":{"attributeAlias":{"type":"string"},"attributeId":{"type":"integer","format":"int64"},"attributeName":{"type":"string"},"attributeSeq":{"type":"integer","format":"int64"},"computed":{"type":"string"},"createFields":{"type":"string"},"datatype":{"type":"string"},"datatypeId":{"type":"integer","format":"int64"},"datatypeOwner":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"dateUpdated":{"type":"string","format":"date-time"},"dbDefault":{"type":"string"},"defaultValue":{"type":"string"},"direction":{"type":"string"},"entExclude":{"type":"string"},"entIndex":{"type":"boolean"},"entityDefinition":{"$ref":"#/definitions/DBDataDiscoveryEntityDef"},"entityFormat":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"entityPrecision":{"type":"integer","format":"int64"},"expValFor":{"type":"string"},"fileFrom":{"type":"integer","format":"int64"},"fileTo":{"type":"integer","format":"int64"},"fileValueEnd":{"type":"string"},"fileValueStart":{"type":"string"},"format":{"type":"string"},"isComputed":{"type":"string"},"jobId":{"type":"integer","format":"int64"},"nullable":{"type":"string"},"precision":{"type":"integer","format":"int64"},"primaryTag":{"type":"string"},"programCreated":{"type":"string"},"programUpdated":{"type":"string"},"projId":{"type":"integer","format":"int64"},"pvId":{"type":"integer","format":"int64"},"rbt":{"type":"string"},"remark2":{"type":"string"},"remark3":{"type":"string"},"remarks":{"type":"string"},"scale":{"type":"integer","format":"int64"},"updateFields":{"type":"string"},"validation":{"type":"string"},"whoCreated":{"type":"string"},"whoUpdated":{"type":"string"},"xpath":{"type":"string"}}},"DBDataDiscoveryEntityDef":{"type":"object","properties":{"aliasOfId":{"type":"integer","format":"int64"},"attributeCount":{"type":"integer","format":"int64"},"attributeList":{"type":"array","items":{"$ref":"#/definitions/DBDataDiscoveryEntityAttrDef"}},"clobId1":{"type":"integer","format":"int64"},"clobId2":{"type":"integer","format":"int64"},"comments":{"type":"string"},"confirmed":{"type":"boolean"},"dataSourceName":{"type":"string"},"databaseName":{"type":"string"},"dateReviewed":{"type":"string","format":"date-time"},"description":{"type":"string"},"entityAlias":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"entityName":{"type":"string"},"entityType":{"type":"string"},"excluded":{"type":"boolean"},"fdId":{"type":"integer","format":"int64"},"fdLocation":{"type":"string"},"fkList":{"type":"array","items":{"$ref":"#/definitions/TableForeignKeyDefinition"}},"foreignKeyCount":{"type":"integer","format":"int64"},"indexCount":{"type":"integer","format":"int64"},"isPII":{"type":"boolean"},"jobId":{"type":"integer","format":"int64"},"ownerName":{"type":"string"},"primaryKeyDescriptor":{"type":"string"},"primaryKeyIndex":{"type":"string"},"profileJobId":{"type":"integer","format":"int64"},"profileName":{"type":"string"},"profileSuId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"},"reason":{"type":"string"},"refName":{"type":"string"},"refOwner":{"type":"string"},"refType":{"type":"string"},"registeredDBMS":{"type":"string"},"registeredName":{"type":"string"},"restPassword":{"type":"string"},"restUrl":{"type":"string"},"restUsername":{"type":"string"},"reviewer":{"type":"string"},"rowCount":{"type":"integer","format":"int64"},"schemaName":{"type":"string"},"serverName":{"type":"string"},"tablespace":{"type":"string"},"uniqueKeys":{"type":"array","items":{"$ref":"#/definitions/DBDataDiscoveryUniqueKey"}},"whereClause":{"type":"string"}}},"DBDataDiscoveryUniqueKey":{"type":"object","properties":{"columnName":{"type":"string"},"columnPos":{"type":"integer","format":"int64"},"createFields":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"dateUpdated":{"type":"string","format":"date-time"},"entityId":{"type":"integer","format":"int64"},"indexName":{"type":"string"},"indexOwner":{"type":"string"},"keyName":{"type":"string"},"keyType":{"type":"string"},"programCreated":{"type":"string"},"programUpdated":{"type":"string"},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"},"updateFields":{"type":"string"},"whoCreated":{"type":"string"},"whoUpdated":{"type":"string"}}},"DBMaskFunction":{"type":"object","properties":{"classifierId":{"type":"integer","format":"int64"},"crossReference":{"type":"string"},"dateFormat":{"type":"string"},"displayName":{"type":"string"},"fromOccurrence":{"type":"string"},"funcId":{"type":"integer","format":"int64"},"functionName":{"type":"string"},"keepNulls":{"type":"boolean"},"maskParams":{"type":"array","items":{"$ref":"#/definitions/DBMaskParams"}},"notes":{"type":"string"},"origFrom":{"type":"integer","format":"int64"},"overrideSql":{"type":"string"},"preformat":{"type":"string"},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"},"restartColumn":{"type":"string"},"substrLength":{"type":"integer","format":"int32"},"substrStart":{"type":"integer","format":"int32"},"tagId":{"type":"integer","format":"int64"},"tagName":{"type":"string"},"tagPrimaryMf":{"$ref":"#/definitions/DBTagPrimaryMf"},"toOccurrence":{"type":"string"},"uniqueColumns":{"type":"string"},"updateDb":{"type":"boolean"},"useMaskedValues":{"type":"boolean"},"xpathElement":{"type":"string"}}},"DBMaskFunctionGroup":{"type":"object","properties":{"classifierBased":{"type":"boolean"},"classifierId":{"type":"integer","format":"int64"},"displayName":{"type":"string"},"groupId":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"groupNotes":{"type":"string"},"isGlobal":{"type":"boolean"},"maskFunction":{"type":"array","items":{"$ref":"#/definitions/DBMaskFunction"}},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"},"tagId":{"type":"integer","format":"int64"},"tagName":{"type":"string"}}},"DBMaskParams":{"type":"object","properties":{"paramId":{"type":"integer","format":"int64"},"paramPosition":{"type":"integer","format":"int32"},"paramValue":{"type":"string"}}},"DBModellingParameters":{"type":"object","properties":{"RefreshToken":{"type":"string"},"classifierPacks":{"type":"array","items":{"type":"integer","format":"int64"}},"connProfiles":{"type":"array","items":{"type":"string"}},"connectionProfiles":{"type":"array","items":{"type":"string"}},"dataSourceNames":{"type":"array","items":{"type":"string"}},"environment":{"type":"string"},"environmentId":{"type":"integer","format":"int64"},"environmentName":{"type":"string"},"filters":{"type":"array","items":{"$ref":"#/definitions/PIIScanFilter"}},"isIncludeFilter":{"type":"boolean"},"jobId":{"type":"integer","format":"int64"},"jobName":{"type":"string"},"jobType":{"type":"string"},"projId":{"type":"integer","format":"int64"},"pverId":{"type":"integer","format":"int64"},"scanLevel":{"type":"integer","format":"int32"},"scanNumericKeys":{"type":"boolean"},"scanStringKeys":{"type":"boolean"},"scanType":{"type":"string","enum":["PRE_SCAN_ONLY","PRE_SCAN_AND_DISCOVER_RELATIONS"]},"storeSamples":{"type":"boolean"},"userName":{"type":"string"}}},"DBPiiApprover":{"type":"object","properties":{"approved":{"type":"boolean"},"comments":{"type":"string"},"dateApproved":{"type":"string","format":"date-time"},"jobId":{"type":"integer","format":"int64"},"reviewerId":{"type":"integer","format":"int64"}}},"DBPiiReport":{"type":"object","properties":{"createdBy":{"type":"string"},"hash":{"type":"string"},"jobId":{"type":"integer","format":"int64"},"pdf":{"type":"string","format":"byte"},"reportClass":{"type":"string","enum":["TDE","AUDITOR","MANAGEMENT"]},"reportId":{"type":"integer","format":"int64"},"timeCreated":{"$ref":"#/definitions/Timestamp"}}},"DBPiiReviewer":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"},"reviewerId":{"type":"integer","format":"int64"},"reviewerName":{"type":"string"},"role":{"type":"string","enum":["REVIEWER","APPROVER"]}}},"DBPiiTag":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"programCreated":{"type":"string"},"programUpdated":{"type":"string"},"projectId":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"},"whoCreated":{"type":"string"},"whoUpdated":{"type":"string"}}},"DBTagPrimaryMf":{"type":"object","properties":{"funcId":{"type":"integer","format":"int64"},"notes":{"type":"string"},"pmfId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"},"tagId":{"type":"integer","format":"int64"}}},"DataDiscoveryJobDTO":{"type":"object","properties":{"environmentId":{"type":"integer","format":"int64"},"environmentName":{"type":"string"},"jobId":{"type":"integer","format":"int64"},"jobName":{"type":"string"},"jobRunning":{"type":"boolean"},"jobState":{"type":"string"},"jobStatus":{"type":"string"},"profileJobId":{"type":"integer","format":"int64"},"profileJobState":{"type":"string"},"profileJobStatus":{"type":"string"},"profileStartDate":{"type":"string","format":"date-time"},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"},"scannedDataSources":{"type":"array","items":{"$ref":"#/definitions/HashMap«string,string»"}},"startDate":{"type":"string","format":"date-time"},"startedBy":{"type":"string"},"stopDate":{"type":"string","format":"date-time"}}},"DataModelEntityAttributeInfo":{"type":"object","properties":{"alias":{"type":"string"},"attributeId":{"type":"integer","format":"int64"},"attributeName":{"type":"string"},"dataType":{"type":"string"},"datatypeId":{"type":"integer","format":"int64"},"precision":{"type":"integer","format":"int64"},"primaryTag":{"type":"string"},"scale":{"type":"integer","format":"int64"}}},"DataModelEntityInfo":{"type":"object","properties":{"alias":{"type":"string"},"attributes":{"$ref":"#/definitions/Iterable«DataModelEntityAttributeInfo»"},"dataSourceName":{"type":"string"},"dataSourceType":{"type":"string"},"databaseName":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"entityName":{"type":"string"},"entityOwner":{"type":"string"},"fromEntityDef":{"$ref":"#/definitions/DBDataDiscoveryEntityDef"},"fullyQualifiedPath":{"type":"string"},"hierarchy":{"$ref":"#/definitions/HierarchyDTO"},"relatedEntities":{"$ref":"#/definitions/Iterable«DataModelEntityInfo»"},"relationshipDetails":{"type":"array","items":{"$ref":"#/definitions/EntityRelationshipDetails"}},"schemaName":{"type":"string"},"uniqueKeys":{"type":"array","items":{"$ref":"#/definitions/DataModelUniqueKeyInfo"}}}},"DataModelExclusionsDetails":{"type":"object","properties":{"active":{"type":"boolean"},"name":{"type":"string"}}},"DataModelExclusionsInfo":{"type":"object","properties":{"attributeDetails":{"type":"array","items":{"$ref":"#/definitions/DataModelExclusionsDetails"}},"jobId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"}}},"DataModelUniqueKeyInfo":{"type":"object","properties":{"columnNames":{"type":"array","items":{"type":"string"}},"indexName":{"type":"string"},"indexOwner":{"type":"string"},"keyName":{"type":"string"},"keyType":{"type":"string"}}},"EntityAttributeRelDetails":{"type":"object","properties":{"childAttributeId":{"type":"integer","format":"int64","description":"Child Attribute ID"},"childAttributeName":{"type":"string","description":"Child Attribute name"},"parentAttributeId":{"type":"integer","format":"int64","description":"Parent Attribute ID"},"parentAttributeName":{"type":"string","description":"Parent Attribute name"},"sequence":{"type":"integer","format":"int64","description":"Attribute sequence"}}},"EntityExclusion":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string"},"value":{"type":"string"}}},"EntityExclusionInfo":{"type":"object","properties":{"exclusions":{"type":"array","items":{"$ref":"#/definitions/EntityExclusion"}},"projectId":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"}}},"EntityMaskInfo":{"type":"object","properties":{"dataSource":{"type":"string"},"databaseName":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"entityName":{"type":"string"},"notes":{"type":"string"},"schemaName":{"type":"string"},"taggedAttributes":{"type":"integer","format":"int64"}}},"EntityRelationshipDetails":{"type":"object","properties":{"childEntityId":{"type":"integer","format":"int64","description":"Child entity ID"},"childEntityName":{"type":"string","description":"Child entity name"},"id":{"type":"integer","format":"int64","description":"ID of the relationship","readOnly":true},"parentEntityId":{"type":"integer","format":"int64","description":"Parent entity ID"},"parentEntityName":{"type":"string","description":"Parent entity name"},"relationshipAttributes":{"type":"array","description":"Relationship Attributes","items":{"$ref":"#/definitions/EntityAttributeRelDetails"}},"relationshipMatcher":{"type":"string","description":"Relationship Matcher"},"relationshipType":{"type":"integer","format":"int64","description":"Relationship type"}}},"ErrorResponse":{"type":"object","properties":{"errorCode":{"type":"string"},"errorDetail":{"type":"string"},"errorMsg":{"type":"string"},"status":{"type":"integer","format":"int32"},"timestamp":{"type":"string"}}},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/definitions/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/definitions/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/definitions/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}}},"ForeignKeyDetails":{"type":"object","properties":{"columnPosition":{"type":"integer","format":"int64","description":"Column Position of the foreign Key"},"foreignKeyName":{"type":"string","description":"Name of the Foreign Key"},"referenceTableColumnName":{"type":"string","description":"Foreign key reference Column name"},"referenceTableName":{"type":"string","description":"Foreign key reference table name"},"sequence":{"type":"integer","format":"int64","description":"Sequential number of the foreign Key"},"tableColumnName":{"type":"string","description":"Foreign key table Column name"},"tableId":{"type":"integer","format":"int64","description":"ID of the table","readOnly":true},"tableName":{"type":"string","description":"Foreign key table name"}}},"GeneratorInfo":{"type":"object","properties":{"comment":{"type":"string","description":"Comment assigned by the user to the generator"},"created":{"type":"string","description":"Timestamp of the generator creation"},"description":{"type":"string","description":"Description of the generator"},"generatorId":{"type":"number","description":"Id of the generator"},"name":{"type":"string","description":"Name of the generator"},"onDemand":{"type":"string","description":"Indicates if the generator is available on demand as service"},"parentId":{"type":"number","description":"Id of the parent"},"projectId":{"type":"integer","format":"int64","description":"Id of the project to which the generator belongs to"},"projectName":{"type":"string","description":"Name of the project to which the generator belongs to"},"type":{"type":"string","description":"Type of the generator"},"updated":{"type":"string","description":"Timestamp of the last updation of the generator"},"versionId":{"type":"integer","format":"int64","description":"Id of the version under which the generator is created"},"versionName":{"type":"string","description":"Name of the version to which the generator belongs to"}}},"HashMap«string,string»":{"type":"object","additionalProperties":{"type":"string"}},"HierarchyDTO":{"type":"object","properties":{"childrenNames":{"type":"string"},"dbType":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"fullyQualifiedPath":{"type":"string"},"jobId":{"type":"integer","format":"int64"},"node":{"type":"array","items":{"$ref":"#/definitions/HierarchyDTO"}},"nodeId":{"type":"integer","format":"int64"},"nodeName":{"type":"string"},"nodePath":{"type":"array","items":{"type":"string"}},"nodeType":{"type":"string"},"numChildren":{"type":"integer","format":"int64"},"parentNodeId":{"type":"integer","format":"int64"},"projectId":{"type":"integer","format":"int64"},"projectVersionId":{"type":"integer","format":"int64"}}},"ImportClassifierResponse":{"type":"object","properties":{"classifiersCreated":{"type":"integer","format":"int32"},"classifiersUpdated":{"type":"integer","format":"int32"},"containersCreated":{"type":"integer","format":"int32"},"containersUpdated":{"type":"integer","format":"int32"},"duplicateClassifiers":{"type":"integer","format":"int32"},"duplicateContainers":{"type":"integer","format":"int32"},"duplicateOption":{"type":"string"},"duplicateSeedlist":{"type":"integer","format":"int32"},"seedListCreated":{"type":"integer","format":"int32"},"seedListUpdated":{"type":"integer","format":"int32"}}},"InputStream":{"type":"object"},"InputStreamResource":{"type":"object","properties":{"description":{"type":"string"},"file":{"$ref":"#/definitions/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/definitions/InputStream"},"open":{"type":"boolean"},"readable":{"type":"boolean"},"uri":{"$ref":"#/definitions/URI"},"url":{"$ref":"#/definitions/URL"}}},"Iterable«DataModelEntityAttributeInfo»":{"type":"object"},"Iterable«DataModelEntityInfo»":{"type":"object"},"Iterable«PiiColumn»":{"type":"object"},"Job":{"type":"object","properties":{"artifactLocation":{"type":"string","description":"Location of the artifact related to the Job"},"created":{"type":"string","format":"date-time","description":"Time at which Job was created in the system"},"createdBy":{"type":"string","description":"Name of the user who submitted the Job"},"description":{"type":"string","description":"Description of the Job"},"duration":{"type":"integer","format":"int64","description":"Amount of time taken for completion of the Job"},"email":{"type":"string","description":"Email address to which job execution report is sent"},"endTime":{"type":"string","format":"date-time","description":"Time at which Job execution has completed"},"jobId":{"type":"integer","format":"int64","description":"Id of the Job"},"jobs":{"type":"array","description":"List of child jobs","items":{"$ref":"#/definitions/Job"}},"name":{"type":"string","description":"Name of the Job"},"origin":{"type":"string","description":"Name of the module that has submitted the Job"},"parameters":{"type":"object","description":"Job related parameters"},"parentId":{"type":"integer","format":"int64","description":"Id of the parent Job if the Job is a child job. Zero otherwise"},"projectId":{"type":"integer","format":"int64","description":"Id of the project for which Job is submitted"},"projectName":{"type":"string","description":"Name of the project for which Job is submitted"},"runningStatus":{"type":"string","description":"Indicates the running status of the Job"},"scheduledTime":{"type":"string","format":"date-time","description":"Time for which Job execution is scheduled"},"startTime":{"type":"string","format":"date-time","description":"Time at which Job execution has begun"},"status":{"type":"string","description":"Status of Job execution"},"statusMessage":{"type":"string","description":"Job's status message"},"type":{"type":"string","description":"Type of the Job"},"versionId":{"type":"integer","format":"int64","description":"Version Id of the project for which Job is submitted"}}},"JobProgress":{"type":"object","properties":{"columnsClassified":{"type":"integer","format":"int64"},"columnsScanned":{"type":"integer","format":"int64"},"listApprovers":{"type":"array","items":{"$ref":"#/definitions/DBPiiApprover"}},"listReviewers":{"type":"array","items":{"$ref":"#/definitions/DBPiiReviewer"}},"tablesClassified":{"type":"integer","format":"int64"},"tablesReviewed":{"type":"integer","format":"int64"},"tablesScanned":{"type":"integer","format":"int64"},"totalApprovers":{"type":"integer","format":"int64"},"totalColumns":{"type":"integer","format":"int64"},"totalReviewers":{"type":"integer","format":"int64"},"totalTables":{"type":"integer","format":"int64"}}},"MaskConfigGroupByTagWithPath":{"type":"object","properties":{"attributeId":{"type":"integer","format":"int64"},"attributeName":{"type":"string"},"dataSource":{"type":"string"},"databaseName":{"type":"string"},"entityId":{"type":"integer","format":"int64"},"entityName":{"type":"string"},"group":{"$ref":"#/definitions/MaskFunctionGroup"},"maskCrossRef":{"type":"integer","format":"int64"},"schemaName":{"type":"string"},"tagName":{"type":"string"}}},"MaskConfigGroupsByTag":{"type":"object","properties":{"currentMaskingGroupList":{"type":"array","items":{"$ref":"#/definitions/MaskConfigGroupByTagWithPath"}},"defaultTagMaskingGroup":{"type":"integer","format":"int64"},"effectiveMaskGroup":{"type":"string"},"effectiveMaskGroupId":{"type":"integer","format":"int64"},"hasWhereClause":{"type":"boolean"},"knownMaskingGroupsList":{"type":"array","items":{"$ref":"#/definitions/MaskFunctionGroup"}},"maskingGroupCount":{"type":"integer","format":"int64"},"tagId":{"type":"integer","format":"int64"},"tagName":{"type":"string"},"unmaskedAttributes":{"type":"array","items":{"$ref":"#/definitions/MaskConfigGroupByTagWithPath"}}}},"MaskFunction":{"type":"object","properties":{"crossReference":{"type":"string"},"dateFormat":{"type":"string"},"displayName":{"type":"string"},"fromOccurrence":{"type":"string"},"keepNulls":{"type":"boolean"},"maskFunctionId":{"type":"integer","format":"int64"},"maskFunctionLabel":{"type":"string"},"maskFunctionName":{"type":"string"},"maskFunctionParams":{"type":"array","items":{"$ref":"#/definitions/MaskFunctionParams"}},"notes":{"type":"string"},"overrideSql":{"type":"string"},"preformat":{"type":"string"},"restartColumn":{"type":"string"},"substrLength":{"type":"integer","format":"int32"},"substrStart":{"type":"integer","format":"int32"},"toOccurrence":{"type":"string"},"uniqueColumns":{"type":"string"},"updateDb":{"type":"boolean"},"useMaskedValues":{"type":"boolean"},"whereClause":{"type":"string"},"xpathElement":{"type":"string"}}},"MaskFunctionGroup":{"type":"object","properties":{"attributeCount":{"type":"integer","format":"int32"},"classifierBased":{"type":"boolean"},"configuration":{"type":"array","items":{"$ref":"#/definitions/MaskFunction"}},"maskGroupId":{"type":"integer","format":"int64"},"maskGroupLabel":{"type":"string"},"maskGroupShared":{"type":"boolean"},"notes":{"type":"string"},"tagName":{"type":"string"}}},"MaskFunctionGroupId":{"type":"object","properties":{"groupId":{"type":"integer","format":"int64"}}},"MaskFunctionParams":{"type":"object","properties":{"pos":{"type":"integer","format":"int32"},"value":{"type":"string"}}},"MaskSetting":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"hasUserSetting":{"type":"boolean"},"hiddenFromUser":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"isBoolean":{"type":"string"},"isChar":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}}},"ModelTableInfo":{"type":"object","properties":{"databaseName":{"type":"string"},"differences":{"type":"string"},"diffrenceReport":{"$ref":"#/definitions/TableReconcileReport"},"entityId":{"type":"integer","format":"int64"},"isUnique":{"type":"boolean"},"profileName":{"type":"string"},"schemaName":{"type":"string"},"status":{"type":"string"},"tableName":{"type":"string"}}},"ObjectDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/definitions/ColumnDetails"}},"explicitNamespaces":{"type":"string"},"fileConnProfId":{"type":"integer","format":"int64"},"fileConnectionProfileName":{"type":"string"},"fileEncoding":{"type":"string"},"fileLocation":{"type":"string"},"fileName":{"type":"string"},"fileStatus":{"type":"integer","format":"int64"},"filecount":{"type":"integer","format":"int64"},"foreignKeys":{"type":"array","items":{"$ref":"#/definitions/ForeignKeyDetails"}},"group":{"type":"string"},"jobFailureMessage":{"type":"string"},"jobId":{"type":"integer","format":"int64"},"noNamespaceSchemaLocation":{"type":"string"},"objectId":{"type":"integer","format":"int64"},"objectName":{"type":"string"},"objectType":{"type":"string"},"parentId":{"type":"integer","format":"int64"},"programUpdated":{"type":"string"},"projectId":{"type":"integer","format":"int64"},"relationships":{"type":"array","items":{"$ref":"#/definitions/RelationshipDetails"}},"rootFilePath":{"type":"string"},"schemaLocation":{"type":"string"},"tableColumnCount":{"type":"string"},"tableForeignKeyCount":{"type":"string"},"tableIndexCount":{"type":"string"},"tableOrder":{"type":"integer","format":"int64"},"tableOwner":{"type":"string"},"tablePrimaryKeyIndex":{"type":"string"},"tableRegisteredDBMS":{"type":"string"},"versionId":{"type":"integer","format":"int64"}}},"ObjectEntriesEffected":{"type":"object","properties":{"code":{"type":"string","enum":["100","101","102","103","200","201","202","203","204","205","206","207","208","226","300","301","302","303","304","305","307","308","400","401","402","403","404","405","406","407","408","409","410","411","412","413","414","415","416","417","418","419","420","421","422","423","424","426","428","429","431","451","500","501","502","503","504","505","506","507","508","509","510","511"]},"jobId":{"type":"integer","format":"int64"},"objectId":{"type":"integer","format":"int64"},"objectsEffected":{"type":"integer","format":"int32"},"successMsg":{"type":"string"}}},"ObjectList":{"type":"object","properties":{"objectIds":{"type":"array","items":{"type":"integer","format":"int64"}}}},"ObjectRequest":{"type":"object","required":["connectionProfileName","objectName","objectType","schema","tableNames"],"properties":{"connectionProfileName":{"type":"string","description":"Name of the connection profile that identifies the database from where you register the tables."},"dataStartsAt":{"type":"integer","format":"int32","description":"Row number from where the data starts from."},"explicitNamespaces":{"type":"string","description":"semicolon delimited namespaces that need to be added explicitly in each exported XML document"},"fileEncoding":{"type":"string","description":"Encoding format of the file that you want to associate to the object that you are creating. Standard character sets include US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE, UTF-16. Default value is UTF-8."},"generatorId":{"type":"integer","format":"int64","description":"Id of the generator in which file data should get imported"},"headerAt":{"type":"integer","format":"int32","description":"Row number of the header."},"importData":{"type":"object","description":"Flag to import the file data to generator","additionalProperties":{"type":"boolean"}},"noNamespaceSchemaLocation":{"type":"string","description":"Location of the XML Schema document that does not have a target namespace."},"objectName":{"type":"string","description":"Name of the object that you are creating. It should be non empty and should not contain the following characters: <,>,:,\",/,\\,|,?,*."},"objectRemoteLocation":{"type":"string","description":"URI Location of the file to associate with the object you are creating.Either of files or objectRemoteLocation are mandatory for object types:XSD,WSDL."},"objectType":{"type":"string","description":"Type of the object you ant to create. Valid types are: XML,XSD,WSDL,RRPAIR,JSON."},"rootName":{"type":"string","description":"Name of the root element, in case of multiple files."},"schema":{"type":"string","description":"Name of the table location from which you want to register tables."},"schemaLocation":{"type":"string","description":"List of the locations of a schema that contains qualified (a schema with a namespace) schema constructs. The first URI reference in each pair is a namespace name, and the second is the location of \ta schema that describes that namespace."},"tableNames":{"type":"array","description":"List of table names that you want to register. In case of CSV registration, list of table names to be skipped in zip file","items":{"type":"string"}}}},"PIIScanFilter":{"type":"object","properties":{"profile":{"type":"string"},"schema":{"type":"string"},"tables":{"type":"array","items":{"type":"string"}}}},"PIIScanParameters":{"type":"object","properties":{"classifierPacks":{"type":"array","items":{"type":"integer","format":"int64"}},"connectionProfiles":{"type":"array","items":{"type":"string"}},"dataSourceNames":{"type":"array","items":{"type":"string"}},"environment":{"type":"string"},"filters":{"type":"array","items":{"$ref":"#/definitions/PIIScanFilter"}},"isIncludeFilter":{"type":"boolean"},"jobId":{"type":"integer","format":"int64"},"jobName":{"type":"string"},"projId":{"type":"integer","format":"int64"},"pverId":{"type":"integer","format":"int64"},"scanLevel":{"type":"integer","format":"int32"},"storeSamples":{"type":"boolean"},"userName":{"type":"string"}}},"PageResult«DBPiiTag»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/DBPiiTag"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«DataModelEntityInfo»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/DataModelEntityInfo"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«EntityMaskInfo»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/EntityMaskInfo"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«EntityRelationshipDetails»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/EntityRelationshipDetails"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«MaskConfigGroupsByTag»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/MaskConfigGroupsByTag"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«MaskFunctionGroup»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/MaskFunctionGroup"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«PiiDataColumn»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/PiiDataColumn"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«PiiData»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/PiiData"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PageResult«PiiTable»":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/PiiTable"}},"numberOfElements":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"}}},"PaginatedResult":{"type":"object","properties":{"elements":{"type":"array","items":{"type":"object"}},"numberOfElements":{"type":"integer","format":"int32"},"totalNumberOfElements":{"type":"integer","format":"int64"}}},"PiiColumn":{"type":"object","properties":{"columnId":{"type":"integer","format":"int64"},"columnName":{"type":"string"},"dataType":{"type":"string"},"rowCount":{"type":"integer","format":"int64"}}},"PiiData":{"type":"object","properties":{"columnCount":{"type":"integer","format":"int64"},"confirmed":{"type":"boolean"},"databaseName":{"type":"string"},"dateReviewed":{"type":"string","format":"date-time"},"matchedSamples":{"type":"integer","format":"int64"},"notPII":{"type":"boolean"},"piiTags":{"type":"array","items":{"type":"string"}},"profileJobId":{"type":"integer","format":"int64"},"profileName":{"type":"string"},"reason":{"type":"string"},"reviewer":{"type":"string"},"rowCount":{"type":"integer","format":"int64"},"schemaName":{"type":"string"},"severity":{"type":"number","format":"double"},"tableId":{"type":"integer","format":"int64"},"tableName":{"type":"string"},"tagHistory":{"type":"array","items":{"$ref":"#/definitions/PiiDataTagHistory"}}}},"PiiDataColumn":{"type":"object","properties":{"action":{"type":"string","enum":["ADD","REMOVE"]},"clsMatches":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"clsMaxMatch":{"type":"integer","format":"int64"},"columnId":{"type":"integer","format":"int64"},"columnName":{"type":"string"},"dataType":{"type":"string"},"dateReviewed":{"type":"string","format":"date-time"},"piiTags":{"type":"array","items":{"type":"string"}},"primaryTag":{"type":"string"},"reason":{"type":"string"},"reviewer":{"type":"string"},"severity":{"type":"number","format":"double"},"tagHistory":{"type":"array","items":{"$ref":"#/definitions/PiiDataTagHistory"}},"tagsSet":{"type":"boolean"}}},"PiiDataTagHistory":{"type":"object","properties":{"action":{"type":"string","enum":["ADDED","REMOVED"]},"columnId":{"type":"integer","format":"int64"},"columnName":{"type":"string"},"dateReviewed":{"type":"string","format":"date-time"},"reason":{"type":"string"},"reviewer":{"type":"string"},"tag":{"type":"string"}}},"PiiHeatMap":{"type":"object","properties":{"databaseNames":{"type":"array","items":{"type":"string"}},"heat":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object"}}},"jobProgress":{"$ref":"#/definitions/JobProgress"},"profiles":{"type":"array","items":{"$ref":"#/definitions/ConnectionProfile"}},"schemaNames":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}},"PiiJob":{"type":"object","properties":{"approved":{"type":"boolean"},"approvedBy":{"type":"string"},"columnClassifierHash":{"type":"integer","format":"int32"},"columnSeedlistHash":{"type":"integer","format":"int32"},"columnsClassified":{"type":"integer","format":"int64"},"columnsScanned":{"type":"integer","format":"int64"},"completeDate":{"type":"string","format":"date-time"},"contentClassifierHash":{"type":"integer","format":"int32"},"contentSeedlistHash":{"type":"integer","format":"int32"},"environment":{"type":"string"},"jobID":{"type":"integer","format":"int64"},"jobName":{"type":"string"},"listApprovers":{"type":"array","items":{"$ref":"#/definitions/DBPiiApprover"}},"listReviewers":{"type":"array","items":{"$ref":"#/definitions/DBPiiReviewer"}},"projectID":{"type":"integer","format":"int64"},"projectName":{"type":"string"},"projectVersionID":{"type":"integer","format":"int64"},"reason":{"type":"string"},"scanLevel":{"type":"integer","format":"int32"},"setup":{"$ref":"#/definitions/PiiSetup"},"severity":{"type":"number","format":"double"},"signOffRequestedDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"},"state":{"type":"string","enum":["CREATED","STARTED","CANCELLING","CANCELLED","SCAN_COMPLETE","APPROVAL_REQUIRED","APPROVED","APPROVAL_REJECTED","FAILED","SIGNED_OFF","SIGN_OFF_REJECTED"]},"stopDate":{"type":"string","format":"date-time"},"storeSamples":{"type":"boolean"},"submittedBy":{"type":"string"},"tablesClassified":{"type":"integer","format":"int64"},"tablesReviewed":{"type":"integer","format":"int64"},"tablesScanned":{"type":"integer","format":"int64"},"totalApprovers":{"type":"integer","format":"int64"},"totalColumns":{"type":"integer","format":"int64"},"totalPii":{"type":"integer","format":"int64"},"totalReviewers":{"type":"integer","format":"int64"},"totalTables":{"type":"integer","format":"int64"},"warnings":{"type":"string"}}},"PiiReviewer":{"type":"object","properties":{"accepted":{"type":"boolean"},"dateReviewed":{"type":"string","format":"date-time"},"reason":{"type":"string"},"reviewerId":{"type":"integer","format":"int64"},"reviewerName":{"type":"string"}}},"PiiSample":{"type":"object","properties":{"columnId":{"type":"integer","format":"int64"},"columnName":{"type":"string"},"columnType":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/definitions/TaggedSample"}}}},"PiiSearch":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"}},"profiles":{"type":"array","items":{"type":"string"}},"rowCounts":{"$ref":"#/definitions/SearchRowCounts"},"schemas":{"type":"array","items":{"type":"string"}},"tables":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}}},"PiiSetup":{"type":"object","properties":{"RefreshToken":{"type":"string"},"classifierPacks":{"type":"array","items":{"type":"integer","format":"int64"}},"connProfiles":{"type":"array","items":{"type":"string"}},"dataSources":{"type":"array","items":{"type":"string"}},"environment":{"type":"string"},"environmentId":{"type":"integer","format":"int64"},"filters":{"type":"array","items":{"$ref":"#/definitions/PIIScanFilter"}},"isIncludeFilter":{"type":"boolean"},"origin":{"type":"string"},"refreshToken":{"type":"string"},"scanLevel":{"type":"integer","format":"int32"},"scanLevelSet":{"type":"boolean"},"scanNumericKeys":{"type":"boolean"},"scanNumericKeysSet":{"type":"boolean"},"scanStringKeys":{"type":"boolean"},"scanStringKeysSet":{"type":"boolean"},"storeSamples":{"type":"boolean"},"storeSamplesSet":{"type":"boolean"}}},"PiiTable":{"type":"object","properties":{"columnCount":{"type":"integer","format":"int64"},"columns":{"$ref":"#/definitions/Iterable«PiiColumn»"},"databaseName":{"type":"string"},"rowCount":{"type":"integer","format":"int64"},"schemaName":{"type":"string"},"tableId":{"type":"integer","format":"int64"},"tableName":{"type":"string"}}},"PrimaryKeyDetails":{"type":"object","properties":{"primaryKeyColumns":{"type":"array","items":{"type":"string"}},"primaryKeyName":{"type":"string"}}},"ProfileRequestResponse":{"type":"object","properties":{"jobId":{"type":"integer","format":"int64"}}},"ReconcileReport":{"type":"object","properties":{"conflictDescription":{"type":"string"},"conflictType":{"type":"string","enum":["COLUMN","FOREIGN_KEY","PRIMARY_KEY","UNIQUE_KEY","INDEX"]}}},"RelationshipColumnDetails":{"type":"object","properties":{"childColumn":{"type":"string","description":"Relationship child column name"},"parentColumn":{"type":"string","description":"Relationship parent column name"},"sequence":{"type":"integer","format":"int64","description":"Relationship column sequence"}}},"RelationshipDetails":{"type":"object","properties":{"childCardinality":{"type":"string","description":"Relationship child Cardinality"},"childTableName":{"type":"string","description":"Relationship child table name"},"childTableOwner":{"type":"string"},"id":{"type":"integer","format":"int64","description":"ID of the relationship","readOnly":true},"parentCardinality":{"type":"string","description":"Relationship parent Cardinality"},"parentTableName":{"type":"string","description":"Relationship parent table name"},"parentTableOwner":{"type":"string"},"relationshipColumns":{"type":"array","description":"Relationship Columns","items":{"$ref":"#/definitions/RelationshipColumnDetails"}},"relationshipDesc":{"type":"string","description":"Relationship description"},"relationshipName":{"type":"string","description":"Relationship name"},"relationshipType":{"type":"integer","format":"int64","description":"Type of relationship"}}},"RootElementBean":{"type":"object","properties":{"name":{"type":"string"},"portBinding":{"type":"string"},"portBindingNameSpace":{"type":"string"},"portType":{"type":"string"}}},"SearchRowCounts":{"type":"object","properties":{"empty":{"type":"array","items":{"type":"integer","format":"int32"}},"large":{"type":"array","items":{"type":"integer","format":"int32"}},"medium":{"type":"array","items":{"type":"integer","format":"int32"}},"small":{"type":"array","items":{"type":"integer","format":"int32"}},"vlarge":{"type":"array","items":{"type":"integer","format":"int32"}}}},"SeedListSnapshot":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifiedBy":{"type":"string"},"revision":{"type":"string"},"seedListDescription":{"type":"string"},"seedListId":{"type":"integer","format":"int64"},"seedListName":{"type":"string"},"seedListOrigin":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"SystemExclusion":{"type":"object","properties":{"connectionProfile":{"type":"string"},"dataSource":{"type":"string"},"databaseExclusions":{"type":"array","items":{"type":"string"}},"dbType":{"type":"string"},"schemaExclusions":{"type":"array","items":{"type":"string"}}}},"SystemExclusionInfo":{"type":"object","properties":{"environmentId":{"type":"integer","format":"int64"},"exclusions":{"type":"array","items":{"$ref":"#/definitions/SystemExclusion"}},"projectId":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"}}},"TableDetails":{"type":"object","properties":{"columns":{"type":"array","description":"List of columns of the table","items":{"$ref":"#/definitions/ColumnDetails"}},"foreignKeys":{"type":"array","description":"List of foreign Keys of the table","items":{"$ref":"#/definitions/ForeignKeyDetails"}},"name":{"type":"string","description":"Name of the table"},"order":{"type":"integer","format":"int64","description":"Order of the table"},"primaryKey":{"description":"Primary key of the table","$ref":"#/definitions/PrimaryKeyDetails"},"relationships":{"type":"array","description":"List of Relationships of the table","items":{"$ref":"#/definitions/RelationshipDetails"}},"rowCount":{"type":"integer","format":"int64","description":"No of rows in the table"},"schema":{"type":"string","description":"Location of the table (schema)"},"tableId":{"type":"integer","format":"int64","description":"ID of the table","readOnly":true}}},"TableForeignKeyDefinition":{"type":"object","properties":{"createFields":{"type":"string"},"dateCreated":{"type":"string","format":"date-time"},"dateUpdated":{"type":"string","format":"date-time"},"programCreated":{"type":"string"},"programUpdated":{"type":"string"},"tfdColumnName":{"type":"string"},"tfdColumnPos":{"type":"integer","format":"int64"},"tfdFkeyName":{"type":"string"},"tfdFkeySeq":{"type":"integer","format":"int64"},"tfdFkeyStatus":{"type":"string"},"tfdProjId":{"type":"integer","format":"int64"},"tfdPvId":{"type":"integer","format":"int64"},"tfdRefColumnName":{"type":"string"},"tfdRefSchemaName":{"type":"string"},"tfdRefTableName":{"type":"string"},"tfdRepeater":{"type":"string"},"tfdSchemaName":{"type":"string"},"tfdTableId":{"type":"integer","format":"int64"},"tfdTableName":{"type":"string"},"updateFields":{"type":"string"},"whoCreated":{"type":"string"},"whoUpdated":{"type":"string"}}},"TableInfo":{"type":"object","properties":{"differences":{"type":"string"},"diffrenceReport":{"$ref":"#/definitions/TableReconcileReport"},"fileName":{"type":"string"},"status":{"type":"string"},"tableName":{"type":"string"},"tableType":{"type":"string"}}},"TableOrderRequest":{"type":"object","required":["override"],"properties":{"ignoredForeignKeys":{"type":"array","description":"List of the Foreign Keys you want to ignore while creating table order","items":{"$ref":"#/definitions/ForeignKeyDetails"}},"ignoredRelationships":{"type":"array","description":"List of Relationships you want to ignore while creating table order","items":{"$ref":"#/definitions/RelationshipDetails"}},"override":{"type":"boolean","example":false,"description":"Flag used to override existing table order"}}},"TableReconcileReport":{"type":"object","properties":{"conflicts":{"type":"array","items":{"$ref":"#/definitions/ReconcileReport"}},"tableName":{"type":"string"}}},"TablesInfo":{"type":"object","properties":{"tableInfoList":{"type":"array","items":{"$ref":"#/definitions/TableInfo"}},"totalNoOfTables":{"type":"integer","format":"int64"}}},"TaggedSample":{"type":"object","properties":{"sampleType":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}}},"Timestamp":{"type":"object","properties":{"date":{"type":"integer","format":"int32"},"day":{"type":"integer","format":"int32"},"hours":{"type":"integer","format":"int32"},"minutes":{"type":"integer","format":"int32"},"month":{"type":"integer","format":"int32"},"nanos":{"type":"integer","format":"int32"},"seconds":{"type":"integer","format":"int32"},"time":{"type":"integer","format":"int64"},"timezoneOffset":{"type":"integer","format":"int32"},"year":{"type":"integer","format":"int32"}}},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}}},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}}},"WhereClauseInfo":{"type":"object","properties":{"attributeId":{"type":"integer","format":"int64"},"maskFunctionId":{"type":"integer","format":"int64"},"maskGroupId":{"type":"integer","format":"int64"},"whereClause":{"type":"string"},"whereClauseId":{"type":"integer","format":"int64"}}}}}