The Import API is an efficient way to load large volumes of data into the Collibra Data Governance Center. The API can automatically differentiate between creating and updating data.
", "version" : "2.0", "x-audience" : "public" }, "servers" : [ { "url" : "/rest/2.0", "variables" : { } } ], "security" : [ { }, { "basicAuth" : [ ] }, { "jwtAuth" : [ ] }, { "oauth2" : [ ] } ], "tags" : [ { "name" : "Import", "description" : "Large volume import operations" }, { "name" : "Import Results", "description" : "Additional information about finished import jobs" } ], "paths" : { "/import/csv-job" : { "post" : { "tags" : [ "Import" ], "summary" : "Starts import from the CSV file in job (asynchronously).", "description" : "Starts import from the CSV file in job (asynchronously).\n\nRequest can either accept id of the uploaded file that contains CSV input which should be used for import - or the file itself.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "import_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"separator" : {
"type" : "string",
"description" : "The delimiter character used to separate entries. The default value is ';'.",
"default" : ";"
},
"quote" : {
"type" : "string",
"description" : "The delimiter character used for quoted entries. The default value is '\"'.",
"default" : "\""
},
"escape" : {
"type" : "string",
"description" : "The delimiter character used to escape separator or quote character. The default value is '\\\\'.",
"default" : "\\"
},
"strictQuotes" : {
"type" : "boolean",
"description" : "Whether the characters outside quotes should be ignored. The default value is false.",
"default" : false
},
"ignoreLeadingWhitespace" : {
"type" : "boolean",
"description" : "Whether whitespace characters before quotes should be ignored. The default value is false.",
"default" : false
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the imported CSV file is the header. The default value is false.",
"default" : false
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and importing the contents of the CSV file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Import job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/excel-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts import from the Excel file in job (asynchronously).",
"description" : "Starts import from the Excel file in job (asynchronously).\n\nRequest can either accept id of the uploaded file that contains Excel input which should be used for import - or the file itself.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "import_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"sheetName" : {
"type" : "string",
"description" : "The name of the Excel sheet\n\n
If the name is null and sheetIndex is null, the first sheet\nof the workbook will be used for the import.\n\n
If the name is null and sheetIndex is not null, the sheet\nwith the index specified by value of sheetIndex will be used for the import.\n"
},
"sheetIndex" : {
"type" : "integer",
"description" : "The index of the Excel sheet\n\n
If the index is null and sheetName is null, the first sheet\nof the workbook will be used for the import.\n\n
If the index is null and sheetName is not null, the sheet\nwith the name specified by value of sheetName will be used for the import.\n",
"format" : "int32"
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the imported Excel sheet is the header. The default value is false.",
"default" : false
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : " The template that should be used for parsing and importing the contents of the Excel file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n [\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n ]\n \n"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Import job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/json-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts import from the JSON file in job (asynchronously).",
"description" : "Starts import from the JSON file in job (asynchronously).\n\nRequest can either accept id of the uploaded file that contains JSON input which should be used for import - or the file itself.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "import_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"allowEmptyAttributeValues" : {
"type" : "boolean",
"description" : "Whether empty attribute values should be allowed during import. The default value is false.
When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is.",
"default" : false
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Import job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/results/{jobId}/errors" : {
"get" : {
"tags" : [ "Import Results" ],
"summary" : "List the errors of a finished import job",
"description" : "Returns a list of errors of a finished import job with the specified ID. By default the maximum number of results is limited to 1000.",
"operationId" : "findImportErrors",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The ID of the job",
"required" : true,
"schema" : {
"type" : "string",
"format" : "uuid"
}
}, {
"name" : "offset",
"in" : "query",
"description" : "The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0
}
}, {
"name" : "countLimit",
"in" : "query",
"description" : "Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : -1
}
} ],
"responses" : {
"200" : {
"description" : "Import errors paged response",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportErrorPagedResponse"
}
}
}
},
"404" : {
"description" : "Import job not found"
},
"400" : {
"description" : "Import job is not finished"
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.view-all" ]
}, {
"oauth2" : [ ]
} ]
}
},
"/import/results/{jobId}/summary" : {
"get" : {
"tags" : [ "Import Results" ],
"summary" : "Retrieve a summary of a finished import job",
"description" : "Returns details about a finished import job with the specified ID such as the total number of resources and types of resources that were added, removed or updated and the number of errors.",
"operationId" : "getImportJobSummary",
"parameters" : [ {
"name" : "jobId",
"in" : "path",
"description" : "The ID of the job",
"required" : true,
"schema" : {
"type" : "string",
"format" : "uuid"
}
} ],
"responses" : {
"200" : {
"description" : "Import job summary",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ImportSummary"
}
}
}
},
"404" : {
"description" : "Import job not found"
},
"400" : {
"description" : "Import job is not finished"
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.view-all" ]
}, {
"oauth2" : [ ]
} ]
}
},
"/import/synchronize/{synchronizationId}/evict" : {
"delete" : {
"tags" : [ "Import" ],
"summary" : "Removes all cache entries corresponding to the provided synchronization id.",
"description" : "Removes all cache entries corresponding to the provided synchronization id.
The synchronization component is optimized to only execute commands that differ from cycle to cycle. Call this method to clear the command cache and force the execution of all commands in this cycle.
Note: this operation does not stop the tracking of the resources identified by the provided synchronization id. The next synchronization process usingthe same id will still be able to detect resources that should be removed.
id already exists.",
"operationId" : "exists",
"parameters" : [ {
"name" : "synchronizationId",
"in" : "path",
"description" : "The synchronization id of the operation.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "Returns true if synchronization id already exists, false otherwise.",
"content" : {
"application/json" : {
"schema" : {
"type" : "boolean"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.view-all" ]
}, {
"oauth2" : [ ]
} ]
}
},
"/import/synchronize" : {
"get" : {
"tags" : [ "Import" ],
"summary" : "Returns synchronization information matching the given search criteria.",
"description" : "Returns synchronization information matching the given search criteria.Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.
The returned synchronization information satisfies all constraints that are specified in this search criteria. By default a result containing 1000 synchronization infos is returned.
", "operationId" : "findSynchronizationInfos", "parameters" : [ { "name" : "offset", "in" : "query", "description" : "The first result to retrieve. If not set (offset =0), results will be retrieved starting from row 0.",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : 0
}
}, {
"name" : "countLimit",
"in" : "query",
"description" : "Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped",
"schema" : {
"type" : "integer",
"format" : "int32",
"default" : -1
}
} ],
"responses" : {
"200" : {
"description" : "The paged response with found synchronization information.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PagedResponseSynchronizationInfo"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.view-all" ]
}, {
"oauth2" : [ ]
} ]
}
},
"/import/synchronize/{synchronizationId}" : {
"delete" : {
"tags" : [ "Import" ],
"summary" : "Removes all information about synchronization process corresponding to provided synchronization id.",
"description" : "Removes all information about synchronization process corresponding to provided synchronization id.This operation stops tracking of synchronization identified by provided synchronization id. The next synchronization process specified with this id will not be able to detect resources that should be removed.
Request can either accept id of the uploaded file that contains CSV input which should be used for import or the file itself. The input file is treated as a part (batch) of synchronization process. After last batch, finalization (cleanup) process should be called.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "synchronization_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"separator" : {
"type" : "string",
"description" : "The delimiter character used to separate entries. The default value is ';'.",
"default" : ";"
},
"quote" : {
"type" : "string",
"description" : "The delimiter character used for quoted entries. The default value is '\"'.",
"default" : "\""
},
"escape" : {
"type" : "string",
"description" : "The delimiter character used to escape separator or quote character. The default value is '\\\\'.",
"default" : "\\"
},
"strictQuotes" : {
"type" : "boolean",
"description" : "Whether the characters outside quotes should be ignored. The default value is false.",
"default" : false
},
"ignoreLeadingWhitespace" : {
"type" : "boolean",
"description" : "Whether whitespace characters before quotes should be ignored. The default value is false.",
"default" : false
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized CSV file is the header. The default value is false.",
"default" : false
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : " The template that should be used for parsing and synchronizing the contents of the CSV file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n [\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n ]\n \n"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization batch job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/synchronize/{synchronizationId}/batch/excel-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts batch synchronization from the Excel file in job (asynchronously).",
"description" : "Starts batch synchronization from the Excel file in job (asynchronously).Request can either accept id of the uploaded file that contains Excel input which should be used for import or the file itself. The input file is treated as a part (batch) of synchronization process. After last batch, finalization (cleanup) process should be called.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "synchronization_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"sheetName" : {
"type" : "string",
"description" : "The name of the Excel sheet.\n\n
If the name is null and sheetIndex is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the name is null and sheetIndex is not null, the sheet\nwith the index specified by value of sheetIndex will be used for the synchronization.\n"
},
"sheetIndex" : {
"type" : "integer",
"description" : "The index of the Excel sheet.\n\n
If the index is null and sheetName is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the index is null and sheetName is not null, the sheet\nwith the name specified by value of sheetName will be used for the synchronization.\n",
"format" : "int32"
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized Excel file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and synchronizing the contents of the Excel file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization batch job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/synchronize/{synchronizationId}/batch/json-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts batch synchronization from the JSON file in job (asynchronously).",
"description" : "Starts batch synchronization from the JSON file in job (asynchronously).Request can either accept id of the uploaded file that contains JSON input which should be used for import or the file itself. The input file is treated as a part (batch) of synchronization process. After last batch, finalization (cleanup) process should be called.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "synchronization_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"allowEmptyAttributeValues" : {
"type" : "boolean",
"description" : "Whether empty attribute values should be allowed during import. The default value is false.
When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is.",
"default" : false
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization batch job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/synchronize/{synchronizationId}/csv-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts full synchronization from the CSV file in job (asynchronously).",
"description" : "Starts full synchronization from the CSV file in job (asynchronously).
Request can either accept id of the uploaded file that contains CSV input which should be used for import or the file itself. The input file is treated as a full input of synchronization process.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "synchronization_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`.",
"default" : "REMOVE_RESOURCES"
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"separator" : {
"type" : "string",
"description" : "The delimiter character used to separate entries. The default value is ';'.",
"default" : ";"
},
"quote" : {
"type" : "string",
"description" : "The delimiter character used for quoted entries. The default value is '\"'.",
"default" : "\""
},
"escape" : {
"type" : "string",
"description" : "The delimiter character used to escape separator or quote character. The default value is '\\\\'.",
"default" : "\\"
},
"strictQuotes" : {
"type" : "boolean",
"description" : "Whether the characters outside quotes should be ignored. The default value is false."
},
"ignoreLeadingWhitespace" : {
"type" : "boolean",
"description" : "Whether whitespace characters before quotes should be ignored. The default value is false."
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized CSV file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and synchronizing the contents of the CSV file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/synchronize/{synchronizationId}/excel-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts full synchronization from the Excel file in job (asynchronously).",
"description" : "Starts full synchronization from the Excel file in job (asynchronously).Request can either accept id of the uploaded file that contains Excel input which should be used for import or the file itself. The input file is treated as a full input of synchronization process.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "synchronization_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`.",
"default" : "REMOVE_RESOURCES"
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"sheetName" : {
"type" : "string",
"description" : "The name of the Excel sheet.\n\n
If the name is null and sheetIndex is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the name is null and sheetIndex is not null, the sheet\nwith the index specified by value of sheetIndex will be used for the synchronization.\n"
},
"sheetIndex" : {
"type" : "integer",
"description" : "The index of the Excel sheet.\n\n
If the index is null and sheetName is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the index is null and sheetName is not null, the sheet\nwith the name specified by value of sheetName will be used for the synchronization.\n",
"format" : "int32"
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized Excel file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and synchronizing the contents of the Excel file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/synchronize/{synchronizationId}/finalize/job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts synchronization finalization in job (asynchronously).",
"description" : "Starts synchronization finalization in job (asynchronously).Note that while the only mandatory parameter is synchronizationId, requests that omit all optional parameters fail because the multipart-based setup requires at least one part to be present in the body. To meet this requirement and still use all the default values, you can pass a dummy part, for example -F 'foo=bar' if using curl.",
"operationId" : "synchronizeFinalizeInJob",
"parameters" : [ {
"name" : "synchronizationId",
"in" : "path",
"description" : "The synchronization ID used to distinguish different synchronizations.",
"required" : true,
"schema" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.
If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`.",
"default" : "REMOVE_RESOURCES"
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"finalizationParameters" : {
"required" : [ "STATUS_ID" ],
"type" : "object",
"additionalProperties" : {
"required" : [ "STATUS_ID" ],
"type" : "string",
"description" : "If you have set `finalizationStrategy` to `CHANGE_STATUS`, the status ID for the assets that no longer exist in the external system.
NOTE: This parameter must be declared with an 'application/json' content type.
DEPRECATED: This parameter is deprecated and will be removed in the future. Please, use missingAssetStatusId.", "example" : "{ \\\"STATUS_ID\\\": \\\"00000000-0000-0000-0000-000000005066\\\" };type=application/json", "deprecated" : true }, "description" : "If you have set `finalizationStrategy` to `CHANGE_STATUS`, the status ID for the assets that no longer exist in the external system.
NOTE: This parameter must be declared with an 'application/json' content type.
DEPRECATED: This parameter is deprecated and will be removed in the future. Please, use missingAssetStatusId.",
"example" : "{ \\\"STATUS_ID\\\": \\\"00000000-0000-0000-0000-000000005066\\\" };type=application/json",
"deprecated" : true
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the operation should continue if some of the finalization steps failed to execute. The default value is false.
If true, the valid steps are still committed to the database, which can lead to partial results being stored.",
"default" : false
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization finalization job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
},
"/import/synchronize/{synchronizationId}/json-job" : {
"post" : {
"tags" : [ "Import" ],
"summary" : "Starts full synchronization from the JSON file in job (asynchronously).",
"description" : "Starts full synchronization from the JSON file in job (asynchronously).
Request can either accept id of the uploaded file that contains JSON input which should be used for import or the file itself. The input file is treated as a full input of synchronization process.
false.",
"default" : false
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int32",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods.",
"default" : false
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true,
"default" : false
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set.",
"default" : "synchronization_file"
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted.",
"default" : false
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored.",
"default" : false
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing relations for the specified relation types be replaced or should the import only add new relations. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string",
"description" : "Should all existing attributes for the specified attribute types be replaced or should the import only add new attributes whose value didn't exist yet. Possible values are: ADD_OR_IGNORE and REPLACE. The default value is: REPLACE.",
"default" : "REPLACE"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`.",
"default" : "REMOVE_RESOURCES"
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"allowEmptyAttributeValues" : {
"type" : "boolean",
"description" : "Whether empty attribute values should be allowed during import. The default value is false.
When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is.",
"default" : false
}
}
}
}
}
},
"responses" : {
"200" : {
"description" : "Synchronization job successfully started.",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Job"
}
}
}
}
},
"security" : [ {
"basicAuth" : [ ]
}, {
"jwtAuth" : [ ]
}, {
"oauth2" : [ "kg.manage-all" ]
} ]
}
}
},
"components" : {
"schemas" : {
"Job" : {
"required" : [ "id", "resourceType" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The id of the represented object (entity).",
"format" : "uuid"
},
"createdBy" : {
"type" : "string",
"description" : "The id of the user that created this resource.",
"format" : "uuid",
"example" : "4d250cc5-e583-4640-9874-b93d82c7a6cb"
},
"createdOn" : {
"type" : "integer",
"description" : "The timestamp (in UTC time standard) of the creation of this resource.",
"format" : "int64",
"example" : 1475503010320
},
"lastModifiedBy" : {
"type" : "string",
"description" : "The id of the user who modified this resource the last time.",
"format" : "uuid",
"example" : "a073ff90-e7bc-4b35-ba90-c4d475f642fe"
},
"lastModifiedOn" : {
"type" : "integer",
"description" : "The timestamp (in UTC time standard) of the last modification of this resource.",
"format" : "int64",
"example" : 1476703764163
},
"system" : {
"type" : "boolean",
"description" : "Whether this is a system resource or not."
},
"resourceType" : {
"type" : "string",
"description" : "The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...].\nThis property is deprecated and will be removed in the future. In order to stay backwards compatible\nand to enable introduction of new types of resources, where necessary, a resource discriminator\nproperty (of type String) has been added to specific subtypes of Resource,\ne.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute.\nFor new types of resource that didn't exist before this change, the resourceType will be\nBaseDataType.\n",
"deprecated" : true,
"enum" : [ "View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context" ]
},
"name" : {
"type" : "string",
"description" : "The name of the resource.",
"example" : "Test name"
},
"type" : {
"type" : "string",
"description" : "The type of the job.",
"example" : "IMPORT"
},
"userId" : {
"type" : "string",
"description" : "The ID of the user that initiated this job.",
"format" : "uuid"
},
"visibility" : {
"type" : "integer",
"description" : "The visibility of the job.",
"format" : "int32"
},
"progressPercentage" : {
"type" : "number",
"description" : "The progress percentage of the job.",
"format" : "double",
"example" : 50.0
},
"cancelable" : {
"type" : "boolean",
"description" : "Whether this job is cancelable or not. If set to false it will not be possible to cancel the job once submitted."
},
"startDate" : {
"type" : "integer",
"description" : "The start date of the job.",
"format" : "int64",
"example" : 1488016800
},
"endDate" : {
"type" : "integer",
"description" : "The end date of the job.",
"format" : "int64",
"example" : 1488021800
},
"state" : {
"type" : "string",
"description" : "The state of the job.",
"example" : "COMPLETED",
"enum" : [ "WAITING", "RUNNING", "CANCELING", "COMPLETED", "CANCELED", "ERROR" ]
},
"result" : {
"type" : "string",
"description" : "The result of the job.",
"example" : "SUCCESS",
"enum" : [ "NOT_SET", "SUCCESS", "COMPLETED_WITH_ERROR", "FAILURE", "ABORTED" ]
},
"message" : {
"type" : "string",
"description" : "The message of the job.",
"example" : "Import finished in 12s."
}
},
"description" : "Represents a job. Job is a single atomic task that is to be performed asynchronously"
},
"ImportCsvInJobRequest" : {
"required" : [ "escape", "quote", "separator", "template" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.
If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"separator" : {
"type" : "string",
"description" : "The delimiter character used to separate entries. The default value is ';'."
},
"quote" : {
"type" : "string",
"description" : "The delimiter character used for quoted entries. The default value is '\"'."
},
"escape" : {
"type" : "string",
"description" : "The delimiter character used to escape separator or quote character. The default value is '\\\\'."
},
"strictQuotes" : {
"type" : "boolean",
"description" : "Whether the characters outside quotes should be ignored. The default value is false."
},
"ignoreLeadingWhitespace" : {
"type" : "boolean",
"description" : "Whether whitespace characters before quotes should be ignored. The default value is false."
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the imported CSV file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and importing the contents of the CSV file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
}
},
"description" : "The request defining import call properties from a CSV file."
},
"ImportExcelInJobRequest" : {
"required" : [ "template" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"sheetName" : {
"type" : "string",
"description" : "The name of the Excel sheet\n\n
If the name is null and sheetIndex is null, the first sheet\nof the workbook will be used for the import.\n\n
If the name is null and sheetIndex is not null, the sheet\nwith the index specified by value of sheetIndex will be used for the import.\n"
},
"sheetIndex" : {
"type" : "integer",
"description" : "The index of the Excel sheet\n\n
If the index is null and sheetName is null, the first sheet\nof the workbook will be used for the import.\n\n
If the index is null and sheetName is not null, the sheet\nwith the name specified by value of sheetName will be used for the import.\n",
"format" : "int32"
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the imported Excel sheet is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : " The template that should be used for parsing and importing the contents of the Excel file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n [\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n ]\n \n"
}
},
"description" : "The request defining import call properties from an Excel file."
},
"AssetIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"domain" : {
"$ref" : "#/components/schemas/DomainIdentifier"
}
}
},
"AssetImportCommand" : {
"type" : "object",
"properties" : {
"identifier" : {
"$ref" : "#/components/schemas/AssetIdentifier"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"responsibilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Owner"
}
}
},
"name" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
},
"domain" : {
"$ref" : "#/components/schemas/DomainIdentifier"
},
"type" : {
"$ref" : "#/components/schemas/AssetTypeIdentifier"
},
"status" : {
"$ref" : "#/components/schemas/StatusIdentifier"
},
"attributes" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttributeValue"
}
}
},
"relations" : {
"type" : "object",
"additionalProperties" : {
"uniqueItems" : true,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AssetIdentifier"
}
}
},
"tags" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"resourceType" : {
"type" : "string"
}
}
},
"AssetTypeIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"name" : {
"type" : "string"
},
"publicId" : {
"type" : "string"
}
}
},
"AttributeValue" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string"
},
"values" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"CommunityIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"CommunityImportCommand" : {
"type" : "object",
"properties" : {
"identifier" : {
"$ref" : "#/components/schemas/CommunityIdentifier"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"responsibilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Owner"
}
}
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"language" : {
"type" : "string"
},
"parent" : {
"$ref" : "#/components/schemas/CommunityIdentifier"
},
"resourceType" : {
"type" : "string"
}
}
},
"ComplexRelationIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
},
"relations" : {
"type" : "object",
"additionalProperties" : {
"uniqueItems" : true,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AssetIdentifier"
}
}
}
}
},
"ComplexRelationImportCommand" : {
"type" : "object",
"properties" : {
"identifier" : {
"$ref" : "#/components/schemas/ComplexRelationIdentifier"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"complexRelationType" : {
"$ref" : "#/components/schemas/ComplexRelationTypeIdentifier"
},
"attributes" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttributeValue"
}
}
},
"relations" : {
"type" : "object",
"additionalProperties" : {
"uniqueItems" : true,
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AssetIdentifier"
}
}
},
"resourceType" : {
"type" : "string"
}
}
},
"ComplexRelationTypeIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"name" : {
"type" : "string"
}
}
},
"DomainIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"community" : {
"$ref" : "#/components/schemas/CommunityIdentifier"
}
}
},
"DomainImportCommand" : {
"type" : "object",
"properties" : {
"identifier" : {
"$ref" : "#/components/schemas/DomainIdentifier"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"responsibilities" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Owner"
}
}
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"community" : {
"$ref" : "#/components/schemas/CommunityIdentifier"
},
"type" : {
"$ref" : "#/components/schemas/DomainTypeIdentifier"
},
"resourceType" : {
"type" : "string"
}
}
},
"DomainTypeIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"name" : {
"type" : "string"
},
"publicId" : {
"type" : "string"
}
}
},
"ExternalIdentifier" : {
"type" : "object",
"properties" : {
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
}
}
},
"ImportJsonInJobRequest" : {
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Delete the file from the Collibra Platform if the import / synchronization job is successful. The default value is false
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"allowEmptyAttributeValues" : {
"type" : "boolean",
"description" : "Whether empty attribute values should be allowed during import. The default value is false.
When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is."
}
},
"description" : "The request defining import call properties from a JSON file.",
"anyOf" : [ {
"$ref" : "#/components/schemas/CommunityImportCommand"
}, {
"$ref" : "#/components/schemas/DomainImportCommand"
}, {
"$ref" : "#/components/schemas/AssetImportCommand"
}, {
"$ref" : "#/components/schemas/MappingImportCommand"
}, {
"$ref" : "#/components/schemas/ComplexRelationImportCommand"
} ]
},
"MappingIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
},
"dgcId" : {
"type" : "string",
"format" : "uuid"
},
"asset" : {
"$ref" : "#/components/schemas/AssetIdentifier"
},
"domain" : {
"$ref" : "#/components/schemas/DomainIdentifier"
},
"community" : {
"$ref" : "#/components/schemas/CommunityIdentifier"
},
"complexRelation" : {
"$ref" : "#/components/schemas/ComplexRelationIdentifier"
}
}
},
"MappingImportCommand" : {
"type" : "object",
"properties" : {
"identifier" : {
"$ref" : "#/components/schemas/MappingIdentifier"
},
"indexes" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"externalSystemId" : {
"type" : "string"
},
"externalEntityId" : {
"type" : "string"
},
"dgcId" : {
"type" : "string",
"format" : "uuid"
},
"asset" : {
"$ref" : "#/components/schemas/AssetIdentifier"
},
"domain" : {
"$ref" : "#/components/schemas/DomainIdentifier"
},
"community" : {
"$ref" : "#/components/schemas/CommunityIdentifier"
},
"complexRelation" : {
"$ref" : "#/components/schemas/ComplexRelationIdentifier"
},
"extEntityUrl" : {
"type" : "string"
},
"lastSyncDate" : {
"type" : "integer",
"format" : "int64"
},
"syncAction" : {
"type" : "string",
"enum" : [ "ADD", "UPDATE", "REMOVE" ]
},
"description" : {
"type" : "string"
},
"resourceType" : {
"type" : "string"
}
}
},
"Owner" : {
"type" : "object",
"properties" : {
"user" : {
"$ref" : "#/components/schemas/UserIdentifier"
},
"userGroup" : {
"$ref" : "#/components/schemas/UserGroupIdentifier"
}
}
},
"StatusIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
},
"name" : {
"type" : "string"
}
}
},
"UserGroupIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
}
}
},
"UserIdentifier" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"format" : "uuid"
}
}
},
"ImportCommandReference" : {
"type" : "object",
"properties" : {
"indices" : {
"type" : "array",
"description" : "A list of indices of the import command in the input file.",
"items" : {
"type" : "integer",
"description" : "A list of indices of the import command in the input file.",
"format" : "int32"
}
},
"identifier" : {
"type" : "string",
"description" : "Import command identifier."
}
},
"description" : "A reference to the import command."
},
"ImportError" : {
"type" : "object",
"properties" : {
"errorType" : {
"type" : "string",
"description" : "Import error type.",
"enum" : [ "VALIDATION", "RUNTIME" ]
},
"resourceType" : {
"type" : "string",
"description" : "Import resource type.",
"enum" : [ "COMMUNITY", "DOMAIN", "ASSET", "ATTRIBUTE", "RELATION", "COMPLEX_RELATION", "MAPPING", "RESPONSIBILITY" ]
},
"errorMessage" : {
"type" : "string",
"description" : "User friendly error message."
},
"command" : {
"$ref" : "#/components/schemas/ImportCommandReference"
}
},
"description" : "Import job error."
},
"ImportErrorPagedResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of results.",
"format" : "int64",
"example" : 1000
},
"offset" : {
"type" : "integer",
"description" : "The offset for the results.",
"format" : "int64",
"example" : 10
},
"limit" : {
"type" : "integer",
"description" : "The maximum number of results to be returned.",
"format" : "int64",
"example" : 100
},
"results" : {
"type" : "array",
"description" : "The list of results.",
"items" : {
"$ref" : "#/components/schemas/ImportError"
}
}
}
},
"PagedResponseImportError" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of results.",
"format" : "int64",
"example" : 1000
},
"offset" : {
"type" : "integer",
"description" : "The offset for the results.",
"format" : "int64",
"example" : 10
},
"limit" : {
"type" : "integer",
"description" : "The maximum number of results to be returned.",
"format" : "int64",
"example" : 100
},
"results" : {
"type" : "array",
"description" : "The list of results.",
"items" : {
"$ref" : "#/components/schemas/ImportError"
}
}
},
"description" : "Response containing the paged information."
},
"CategoryReference" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The ID of the category.",
"format" : "uuid"
},
"name" : {
"type" : "string",
"description" : "The name of the category."
}
},
"description" : "A reference to the type of resource, for example Physical Data Dictionary or Business Term."
},
"ImportCounters" : {
"type" : "object",
"properties" : {
"added" : {
"type" : "integer",
"description" : "The number of added resources.",
"format" : "int32"
},
"removed" : {
"type" : "integer",
"description" : "The number of removed resources.",
"format" : "int32"
},
"updated" : {
"type" : "integer",
"description" : "The number of updated resources.",
"format" : "int32"
}
},
"description" : "The number of added, removed or updated resources."
},
"ImportSummary" : {
"type" : "object",
"properties" : {
"resourceTypes" : {
"type" : "array",
"description" : "A list of the resource type import summary.",
"items" : {
"$ref" : "#/components/schemas/ResourceTypeSummary"
}
},
"errorsCount" : {
"type" : "integer",
"description" : "The total number of errors the occurred during the import.",
"format" : "int32"
},
"importJobState" : {
"type" : "string",
"description" : "Import job state.",
"enum" : [ "COMPLETED", "FAILED", "COMPLETED_WITH_ERRORS", "ABORTED" ]
}
},
"description" : "A summary of the import."
},
"ResourceTypeSummary" : {
"type" : "object",
"properties" : {
"resourceType" : {
"type" : "string",
"description" : "Import resource type.",
"enum" : [ "COMMUNITY", "DOMAIN", "ASSET", "ATTRIBUTE", "RELATION", "COMPLEX_RELATION", "MAPPING", "RESPONSIBILITY" ]
},
"counters" : {
"$ref" : "#/components/schemas/ImportCounters"
},
"subcategories" : {
"type" : "array",
"description" : "A detailed summary of the number of resources that have been affected by the import job. This can be empty for some resource types, f.e. Mapping.",
"items" : {
"$ref" : "#/components/schemas/SubcategorySummary"
}
}
},
"description" : "A summary of the import for a particular resource, for example Community, Domain or Asset."
},
"SubcategorySummary" : {
"type" : "object",
"properties" : {
"category" : {
"$ref" : "#/components/schemas/CategoryReference"
},
"counters" : {
"$ref" : "#/components/schemas/ImportCounters"
}
},
"description" : "A summary of the import for a particular type of resource, for example Physical Data Dictionary or Business Term."
},
"PagedResponseSynchronizationInfo" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of results.",
"format" : "int64",
"example" : 1000
},
"offset" : {
"type" : "integer",
"description" : "The offset for the results.",
"format" : "int64",
"example" : 10
},
"limit" : {
"type" : "integer",
"description" : "The maximum number of results to be returned.",
"format" : "int64",
"example" : 100
},
"results" : {
"type" : "array",
"description" : "The list of results.",
"items" : {
"$ref" : "#/components/schemas/SynchronizationInfo"
}
}
},
"description" : "Response containing the paged information."
},
"SynchronizationInfo" : {
"type" : "object",
"properties" : {
"synchronizationId" : {
"type" : "string",
"description" : "The id of the synchronization.",
"example" : "ABCDEF123456789"
}
},
"description" : "Represents a synchronization information."
},
"FindSynchronizationRequest" : {
"type" : "object",
"properties" : {
"offset" : {
"type" : "integer",
"format" : "int32"
},
"limit" : {
"type" : "integer",
"format" : "int32"
},
"countLimit" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "The search criteria for synchronization information.\nOnly parameters that are specified in this request and have not null values are used for filtering.\nAll other parameters are ignored.\nThe returned synchronization information satisfy all constraints that are specified in this search criteria.\nBy default a result containing 1000 synchronization infos is returned.\n"
},
"SynchronizationBatchCsvInJobRequest" : {
"required" : [ "escape", "quote", "separator", "synchronizationId", "template" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.
If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"separator" : {
"type" : "string",
"description" : "The delimiter character used to separate entries. The default value is ';'."
},
"quote" : {
"type" : "string",
"description" : "The delimiter character used for quoted entries. The default value is '\"'."
},
"escape" : {
"type" : "string",
"description" : "The delimiter character used to escape separator or quote character. The default value is '\\\\'."
},
"strictQuotes" : {
"type" : "boolean",
"description" : "Whether the characters outside quotes should be ignored. The default value is false."
},
"ignoreLeadingWhitespace" : {
"type" : "boolean",
"description" : "Whether whitespace characters before quotes should be ignored. The default value is false."
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized CSV file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : " The template that should be used for parsing and synchronizing the contents of the CSV file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n [\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n ]\n \n"
}
},
"description" : "The request defining batch synchronization call properties from a CSV file."
},
"SynchronizationBatchExcelInJobRequest" : {
"required" : [ "synchronizationId", "template" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"sheetName" : {
"type" : "string",
"description" : "The name of the Excel sheet.\n\n
If the name is null and sheetIndex is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the name is null and sheetIndex is not null, the sheet\nwith the index specified by value of sheetIndex will be used for the synchronization.\n"
},
"sheetIndex" : {
"type" : "integer",
"description" : "The index of the Excel sheet.\n\n
If the index is null and sheetName is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the index is null and sheetName is not null, the sheet\nwith the name specified by value of sheetName will be used for the synchronization.\n",
"format" : "int32"
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized Excel file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and synchronizing the contents of the Excel file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
}
},
"description" : "The request defining batch synchronization call properties from a Excel file."
},
"SynchronizationBatchJsonInJobRequest" : {
"required" : [ "synchronizationId" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"allowEmptyAttributeValues" : {
"type" : "boolean",
"description" : "Whether empty attribute values should be allowed during import. The default value is false.
When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is."
}
},
"description" : "The request defining synchronization call properties from a JSON file."
},
"SynchronizationCsvInJobRequest" : {
"required" : [ "escape", "quote", "separator", "synchronizationId", "template" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.
If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"separator" : {
"type" : "string",
"description" : "The delimiter character used to separate entries. The default value is ';'."
},
"quote" : {
"type" : "string",
"description" : "The delimiter character used for quoted entries. The default value is '\"'."
},
"escape" : {
"type" : "string",
"description" : "The delimiter character used to escape separator or quote character. The default value is '\\\\'."
},
"strictQuotes" : {
"type" : "boolean",
"description" : "Whether the characters outside quotes should be ignored. The default value is false."
},
"ignoreLeadingWhitespace" : {
"type" : "boolean",
"description" : "Whether whitespace characters before quotes should be ignored. The default value is false."
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized CSV file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and synchronizing the contents of the CSV file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
},
"finalizationParameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"description" : "The request defining synchronization call properties from a CSV file."
},
"SynchronizationExcelInJobRequest" : {
"required" : [ "synchronizationId", "template" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"sheetName" : {
"type" : "string",
"description" : "The name of the Excel sheet.\n\n
If the name is null and sheetIndex is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the name is null and sheetIndex is not null, the sheet\nwith the index specified by value of sheetIndex will be used for the synchronization.\n"
},
"sheetIndex" : {
"type" : "integer",
"description" : "The index of the Excel sheet.\n\n
If the index is null and sheetName is null, the first sheet\nof the workbook will be used for the synchronization.\n
If the index is null and sheetName is not null, the sheet\nwith the name specified by value of sheetName will be used for the synchronization.\n",
"format" : "int32"
},
"headerRow" : {
"type" : "boolean",
"description" : "Whether the first row of the synchronized Excel file is the header. The default value is false."
},
"template" : {
"minLength" : 1,
"type" : "string",
"description" : "The template that should be used for parsing and synchronizing the contents of the Excel file.\n\n
There is one placeholder currently supported:\n
Example of a correct JSON template:
\n\n[\n {\n \"resourceType\": \"Asset\",\n \"identifier\": {\n \"name\": \"${1}\",\n \"domain\": {\n \"name\": \"${2}\",\n \"community\": {\n \"name\": \"Some Community\"\n }\n }\n },\n \"attributes\" : {\n \"00000000-0000-0000-0000-000000003115\" : [ {\n \"value\" : \"${3}\"\n } ],\n \"00000000-0000-0000-0000-000000000222\" : [ {\n \"value\" : \"${4}\"\n } ]\n }\n }\n]\n\n"
},
"finalizationParameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"description" : "The request defining synchronization call properties from a Excel file."
},
"SynchronizationFinalizationRequest" : {
"required" : [ "synchronizationId" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"finalizationParameters" : {
"required" : [ "STATUS_ID" ],
"type" : "object",
"additionalProperties" : {
"required" : [ "STATUS_ID" ],
"type" : "string",
"description" : "If you have set `finalizationStrategy` to `CHANGE_STATUS`, the status ID for the assets that no longer exist in the external system.
NOTE: This parameter must be declared with an 'application/json' content type.
DEPRECATED: This parameter is deprecated and will be removed in the future. Please, use missingAssetStatusId.", "example" : "{ \\\"STATUS_ID\\\": \\\"00000000-0000-0000-0000-000000005066\\\" };type=application/json", "deprecated" : true }, "description" : "If you have set `finalizationStrategy` to `CHANGE_STATUS`, the status ID for the assets that no longer exist in the external system.
NOTE: This parameter must be declared with an 'application/json' content type.
DEPRECATED: This parameter is deprecated and will be removed in the future. Please, use missingAssetStatusId.",
"example" : "{ \\\"STATUS_ID\\\": \\\"00000000-0000-0000-0000-000000005066\\\" };type=application/json",
"deprecated" : true
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the operation should continue if some of the finalization steps failed to execute. The default value is false.
If true, the valid steps are still committed to the database, which can lead to partial results being stored."
}
},
"description" : "The request defining synchronization finalization call properties."
},
"SynchronizationJsonInJobRequest" : {
"required" : [ "synchronizationId" ],
"type" : "object",
"properties" : {
"sendNotification" : {
"type" : "boolean",
"description" : "Whether job status notification should be sent. The default value is false."
},
"batchSize" : {
"minimum" : 1,
"type" : "integer",
"description" : "The batchSize parameter is now deprecated and is ignored during command execution.",
"format" : "int64",
"deprecated" : true,
"default" : 1000
},
"simulation" : {
"type" : "boolean",
"description" : "Whether the import should be triggered as a simulation. The default value is false.
If true, the result of the import simulation is available at the end of the job but none of the changes are applied in Collibra.
This parameter does not apply to synchronization requests. It is only relevant for import and ignored for synchronization methods."
},
"saveResult" : {
"type" : "boolean",
"description" : "Whether the import Result should be persisted or forgotten. The default value is false.
If true, the list of added/updated/removed resources will be stored in the job message.
If the resulting job message is too long, no resource information will be stored.
DEPRECATED:This parameter is deprecated and will be removed in the future..",
"deprecated" : true
},
"synchronizationId" : {
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"fileId" : {
"type" : "string",
"description" : "The id of uploaded file.
NOTE: if this field is used, file should not be set.",
"format" : "uuid"
},
"file" : {
"type" : "string",
"description" : "The file to upload. If set, then also fileName should be provided.
NOTE: if this field is used, fileId should not be set.",
"format" : "binary"
},
"fileName" : {
"type" : "string",
"description" : "The name of the file to upload. If set, then also file should be provided.
NOTE: if this field is used, fileId should not be set."
},
"deleteFile" : {
"type" : "boolean",
"description" : "Whether the file should be deleted after the synchronization job is finished, regardless of the result. The default value is false.
NOTE: if the file corresponds to an attachment, the attachment will be deleted."
},
"continueOnError" : {
"type" : "boolean",
"description" : "Whether the import should continue if some of the import commands are invalid or failed to execute. The default value is false.
If true, the valid commands are still committed to the database, which can lead to partial results being stored."
},
"relationsAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"attributesAction" : {
"pattern" : "ADD_OR_IGNORE|REPLACE",
"type" : "string"
},
"finalizationStrategy" : {
"pattern" : "REMOVE_RESOURCES|CHANGE_STATUS|IGNORE",
"type" : "string",
"description" : "The synchronization finalization strategy used in the clean up action. This determines whether to remove, ignore or change the status of assets that no longer exist in the external system.
Possible values are `REMOVE_RESOURCES`, `CHANGE_STATUS` and `IGNORE`.
When you select `CHANGE_STATUS`, you must also provide a value for `missingAssetStatusId`."
},
"missingAssetStatusId" : {
"type" : "string",
"description" : "If finalizationStrategy is set to `CHANGE_STATUS` then this parameter determines the new status ID for assets that no longer exist in the external system.",
"format" : "uuid"
},
"finalizationParameters" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"allowEmptyAttributeValues" : {
"type" : "boolean",
"description" : "Whether empty attribute values should be allowed during import. The default value is false.
When false (default), attribute values that are empty or blank are filtered out and not imported. When true, empty attribute values are preserved and imported as-is."
}
},
"description" : "The request defining synchronization call properties from a JSON file."
}
},
"securitySchemes" : {
"basicAuth" : {
"type" : "http",
"description" : "Collibra REST API authentication using Basic Authentication.",
"scheme" : "basic"
},
"jwtAuth" : {
"type" : "http",
"description" : "Collibra REST API authentication using JSON Web Token.",
"scheme" : "bearer",
"bearerFormat" : "JWT"
},
"oauth2" : {
"type" : "oauth2",
"description" : "Collibra REST API authentication using OAuth 2.",
"flows" : {
"clientCredentials" : {
"tokenUrl" : "/rest/oauth/v2/token",
"scopes" : {
"kg.manage-all" : "Manage all knowledge graph resources",
"kg.view-all" : "View any knowledge graph resource"
},
"x-scope-permissions" : {
"kg.manage-all" : "RESOURCE_MANAGE_ALL",
"kg.view-all" : "VIEW_PERMISSIONS_VIEW_ALL"
}
}
}
}
}
}
}