Endpoints in the REST API
This version of BMC Helix CMDB supports REST API version 1.0. The base URL for this version of the REST API is
https://<host name>:<port number>/api/cmdb/v1.0
For more information about REST APIs and accessing the Swagger UI for all the CMDB REST APIs, see Using-BMC-Helix-CMDB-functions-in-an-external-application-with-the-REST-API.
{
"swagger" : "2.0",
"host" : "$BMC_CURRENT_HOST_TO_REPLACE$",
"basePath" : "/api",
"tags" : [ {
"name" : "AI Datastores."
}, {
"name" : "AI Job Runs History."
}, {
"name" : "AI Job Runs Information."
}, {
"name" : "AI Jobs directories."
}, {
"name" : "AI Jobs with no runs Information."
}, {
"name" : "AI Jobs."
}, {
"name" : "Api to retrive class icons."
}, {
"name" : "Attribute(s) Create Read Update Delete Operations."
}, {
"name" : "Bulk Instances Get, Update and Delete."
}, {
"name" : "CDM Class Create Read Update Delete Operations."
}, {
"name" : "CI Audit APIs."
}, {
"name" : "CMDB Class Archive Operations."
}, {
"name" : "CMDB Class Index Operations."
}, {
"name" : "CMDB Class Information"
}, {
"name" : "CMDB Class Queries operations"
}, {
"name" : "CMDB Health Exceptions Summary and Details."
}, {
"name" : "CRUD operations on NE Rules."
}, {
"name" : "Centralized Configuration Settings."
}, {
"name" : "ChangeCIs."
}, {
"name" : "Completeness Configurations."
}, {
"name" : "DSM Queries CRUD Operations."
}, {
"name" : "DSM Queries Scan Configurations."
}, {
"name" : "Dashboard Configuration Settings."
}, {
"name" : "Dataset Create Read Update Operations"
}, {
"name" : "Datasource Create, Read, Update, Delete, Statistics operations."
}, {
"name" : "Federation Manager"
}, {
"name" : "Federation Plugins APIs."
}, {
"name" : "Filters Create Read Update Operations"
}, {
"name" : "Get Application Version/s."
}, {
"name" : "Get Logged in user basic details."
}, {
"name" : "Graph Walk API."
}, {
"name" : "Impacts Simulation Resources"
}, {
"name" : "Instanc API for query By Path."
}, {
"name" : "Instance/s Create Read Update Delete Operations."
}, {
"name" : "Menu(s) Read Operations."
}, {
"name" : "NE Class Configurations."
}, {
"name" : "NE Dataset Configuration for a given job."
}, {
"name" : "NE Failed CI Reporting."
}, {
"name" : "NE Job Runs History."
}, {
"name" : "NE Job Runs Information."
}, {
"name" : "NE Jobs with no runs Information."
}, {
"name" : "NE Jobs."
}, {
"name" : "NE Utilities."
}, {
"name" : "PC Catalog Mappings."
}, {
"name" : "Permission(s) Create Read Operations."
}, {
"name" : "RE Failed CI Reporting."
}, {
"name" : "RE Identification Rules Management."
}, {
"name" : "RE Job Runs Information."
}, {
"name" : "RE Jobs with no runs Information."
}, {
"name" : "RE Merge Rules Management."
}, {
"name" : "RE Qualification Rules Management."
}, {
"name" : "RE Queued Jobs Information."
}, {
"name" : "REST Resource for Federation Classes"
}, {
"name" : "REST Resource for Federation Relationships"
}, {
"name" : "Reconcialiation Job Create Read Update Delete Operations."
}, {
"name" : "Reconcialiation Job Events Read operation for a given Job."
}, {
"name" : "Resource for fetching AR server information map"
}, {
"name" : "Resource for operations like Start, Stop etc."
}, {
"name" : "Returns CDM namespaces."
}, {
"name" : "Returns information on CI changes in Production Dataset"
}, {
"name" : "Returns information on dataflow component"
}, {
"name" : "Returns server information like server time"
}, {
"name" : "Schedules."
}, {
"name" : "Service for UDM form operations."
} ],
"schemes" : [ "http", "https" ],
"paths" : {
"/cmdb/v1.0/ai/datastores" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get all data-stores.",
"description" : "Get all data-stores.",
"operationId" : "getAllDataStores",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for AI data-stores."
}
}
}
}
},
"post" : {
"tags" : [ "AI Datastores." ],
"summary" : "Creates a data-store.",
"description" : "Creates a data-store with the provided information in the request body.",
"operationId" : "createDataStore",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The datastore to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AIDataStoreDetails"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/datastores/refresh/{dataStoreId}" : {
"post" : {
"tags" : [ "AI Datastores." ],
"summary" : "refreshes a data-store.",
"description" : "Refreshes a data-store with the provided information in the request body.",
"operationId" : "refreshDataStore",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "The data-store to be refreshed.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/datastores/test" : {
"post" : {
"tags" : [ "AI Datastores." ],
"summary" : "Tests a data-store.",
"description" : "Tests a data-store with the provided information in the request body.",
"operationId" : "testDataStore",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The datastore details to be tested.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AIDataStoreDetails"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get data-store by id.",
"description" : "Get data-store by id.",
"operationId" : "getDataStoreDetailsById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Id of the data-store which needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AIDataStoreDetails"
}
}
}
},
"delete" : {
"tags" : [ "AI Datastores." ],
"summary" : "Deletes the data-store.",
"description" : "Deletes the data-store with the name provided as path param.",
"operationId" : "deleteDataStoreByName",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "The data-store to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "AI Datastores." ],
"summary" : "Updates the datastore.",
"description" : "Updates the data store with definition provided in request body.",
"operationId" : "updateDataStore",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Data Store id which needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The data Store details to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/AIDataStoreDetails"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/ar/datasets" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get datasets list for AR type datastore",
"description" : "Get datasets list for AR type datastore",
"operationId" : "getDatasetsForArDatastore",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ImportDatastoreFieldInfo"
}
}
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/database/schemas" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get schemas list for a database type datastore",
"description" : "Get schemas list for a database type datastore",
"operationId" : "getDatabaseSchemasForDatastore",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/database/schemas/{schemaName}/tables" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get Schema tables for a DB datastore",
"description" : "Get Schema tables for a DB datastore",
"operationId" : "getDatabaseSchemaTables",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
}, {
"name" : "schemaName",
"in" : "path",
"description" : "Schema name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/database/schemas/{schemaName}/tables_views/{tableViewName}/fields" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get schema table fields for a DB datastore",
"description" : "Get schema table fields for a DB datastore",
"operationId" : "getFieldsForDbTypeDatastores",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
}, {
"name" : "schemaName",
"in" : "path",
"description" : "Schema name",
"required" : true,
"type" : "string"
}, {
"name" : "tableViewName",
"in" : "path",
"description" : "Table/view name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ImportDatastoreFieldInfo"
}
}
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/database/schemas/{schemaName}/views" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get Schema views for a DB datastore",
"description" : "Get Schema views for a DB datastore",
"operationId" : "getDatabaseSchemaViews",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
}, {
"name" : "schemaName",
"in" : "path",
"description" : "Schema name",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/files" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get files list for file type datastores",
"description" : "Get files list for file type datastores. For XML type datastores, it will return xpath as well for each file.",
"operationId" : "getFilesForDatastore",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ImportFileDatastoreFileInfo"
}
}
}
}
}
},
"/cmdb/v1.0/ai/datastores/{dataStoreId}/files/{fileName}/fields" : {
"get" : {
"tags" : [ "AI Datastores." ],
"summary" : "Get fields list for a file for file type datastores",
"description" : "Get fields list for a file for file type datastores. For XML type datastores, it will return xpath as well for each file.",
"operationId" : "getFieldsForFileTypeDatastore",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataStoreId",
"in" : "path",
"description" : "Respective data store id.",
"required" : true,
"type" : "string"
}, {
"name" : "fileName",
"in" : "path",
"description" : "Respective file name.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ImportDatastoreFieldInfo"
}
}
}
}
}
},
"/cmdb/v1.0/ai/jobs" : {
"get" : {
"tags" : [ "AI Jobs." ],
"summary" : "Get All Jobs.",
"description" : "Get All Jobs",
"operationId" : "getAllJobs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Jobs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Jobs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name" ]
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Jobs need to be retrieved. If value for this is not provided, All Root Jobs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "job_directory_path",
"in" : "query",
"description" : "Directory id for which the Jobs need to be retrieved. If value for this is not provided, All Root Jobs would be returned.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for AI Jobs."
}
}
}
}
},
"post" : {
"tags" : [ "AI Jobs." ],
"summary" : "Save Cmdb Import Job",
"description" : "Save Cmdb Import job",
"operationId" : "createImportJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "carteServer",
"in" : "query",
"description" : "The carte-server for schedule to run.",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The domain object for creating a cmdb import job.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/ImportJob"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "object"
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/directories" : {
"get" : {
"tags" : [ "AI Jobs directories." ],
"summary" : "Get All Job Directories.",
"description" : "Get All Job Directories",
"operationId" : "getDirectories",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/runinfo/details/{jobRunInstanceId}" : {
"get" : {
"tags" : [ "AI Job Runs History." ],
"summary" : "Get Job Run Detailed Info for AI.",
"description" : "You can retrieve the required job runs history information by using the /{ai}/{jobs}/{runinfo}/{details}/{jobRunInstanceId} parameters.",
"operationId" : "getJobRunDetails",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobRunInstanceId",
"in" : "path",
"description" : "Job Instance Id for which the Job Run details need to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for AI Job Run Info."
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/runinfo/history/{jobDefinitionId}" : {
"get" : {
"tags" : [ "AI Job Runs History." ],
"summary" : "Get Job Runs History Info for AI.",
"description" : "You can retrieve the required job runs history information by using the /{ai}/{jobs}/{runinfo}/{history}/{jobDefinitionId} parameters.",
"operationId" : "getJobRunsHistory",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Job Instance Id for which the Job Runs History need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs History need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_start_date", "-job_start_date", "+job_end_date", "-job_end_date" ]
}, {
"name" : "job_run_status",
"in" : "query",
"description" : "Job run status - All job runs with this status will be retrieved",
"required" : false,
"type" : "string",
"enum" : [ "Running", "Completed", "Failed", "Stopped", "Paused" ]
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for AI Jobs Run History.."
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/runinfo/jobswithnoruns" : {
"get" : {
"tags" : [ "AI Jobs with no runs Information." ],
"summary" : "Get Jobs with no runs for AI.",
"description" : "You can retrieve the required job runs information by using the /{ai}/{jobs}/{runinfo}/{jobswithnoruns} parameters.",
"operationId" : "getJobsWithNoRunsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name" ]
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Jobs need to be retrieved. If value for this is not provided, All Root Job would be returned that are not run.",
"required" : false,
"type" : "string"
}, {
"name" : "job_directory_path",
"in" : "query",
"description" : "Directory id for which the Jobs need to be retrieved. If value for this is not provided, All Root Jobs would be returned that are not run.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for AI Jobs."
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/runinfo/lastruninfo" : {
"get" : {
"tags" : [ "AI Job Runs Information." ],
"summary" : "Get Last Job Runs Info for AI.",
"description" : "You can retrieve the required job runs information by using the /{ai}/{jobs}/{runinfo}/{lastjobsruninfo} parameters.",
"operationId" : "getJobRunsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name" ]
}, {
"name" : "job_definition_id",
"in" : "query",
"description" : "Job Id for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name to filter on",
"required" : false,
"type" : "string"
}, {
"name" : "job_run_status",
"in" : "query",
"description" : "Job Status to filter on. Allowed values are Running, Completed, Failed, Stopped and Paused",
"required" : false,
"type" : "string"
}, {
"name" : "job_directory_path",
"in" : "query",
"description" : "Directory id to filter on.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for AI Jobs Run Info."
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/runinfo/summary" : {
"get" : {
"tags" : [ "AI Job Runs Information." ],
"summary" : "Returns Job summary for AI.",
"description" : "You can retrieve the All Jobs, Not Run Jobs summary by using the /{ai}/{jobs}/{runinfo}/{summary} parameters.",
"operationId" : "getJobSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Specifies the name of the datasource Id for which statistics to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "job_directory_path",
"in" : "query",
"description" : "Directory id to filter on.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for AI last job run summary"
}
}
}
}
},
"/cmdb/v1.0/ai/jobs/{jobDefinitionId}" : {
"get" : {
"tags" : [ "AI Jobs." ],
"summary" : "Get Job by Job Id.",
"description" : "Get Job by Job Instance Id.",
"operationId" : "getJobById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Job Instance Id of job which needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AIJob"
}
}
}
},
"delete" : {
"tags" : [ "AI Jobs." ],
"summary" : "Deletes the job.",
"description" : "Deletes the job with the job id provided as path param.",
"operationId" : "deleteJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "The AI job to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "delete_hierarchy_option",
"in" : "query",
"description" : "Option whether to delete job with its hierarchy",
"required" : true,
"type" : "boolean"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules" : {
"get" : {
"tags" : [ "Schedules." ],
"summary" : "Get Schedules by Job Id.",
"description" : "Get Schedules by Job defination Id.",
"operationId" : "getScheduleByJobId",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Job Id for which schedules need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the schedules need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of schedules to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AIJob"
}
}
}
},
"post" : {
"tags" : [ "Schedules." ],
"summary" : "Creates the schedule.",
"description" : "Creates the schedule with jobId provided in request body.",
"operationId" : "createSchedule",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "carteServer",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The schedule to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules/updateSchedule" : {
"patch" : {
"tags" : [ "Schedules." ],
"summary" : "Update the schedule.",
"description" : "Update the schedule with scheduleId provided.",
"operationId" : "updateSchedule",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "carteServer",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The schedule to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/jobs/{jobDefinitionId}/schedules/{scheduleId}" : {
"delete" : {
"tags" : [ "Schedules." ],
"summary" : "Deletes the schedule.",
"description" : "Deletes the schedule with the schedule id provided as path param.",
"operationId" : "deleteSchedule",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "The schedule to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "scheduleId",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ai/udm/attachmentsets" : {
"get" : {
"tags" : [ "Service for UDM form operations." ],
"summary" : "Get attachment sets list",
"description" : "path: /cmdb/v1.0/ai/udm/attachmentsets",
"operationId" : "getAttachmentSetNames",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for attachment set list."
}
}
}
}
},
"/cmdb/v1.0/ai/udm/carteservers" : {
"get" : {
"tags" : [ "Service for UDM form operations." ],
"summary" : "Get Carte Server details list",
"description" : "path: /cmdb/v1.0/ai/udm/carteservers",
"operationId" : "getCarteServersInfo",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Carte Servers List."
}
}
}
}
},
"/cmdb/v1.0/archivedclasses" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Returns the list of CDM classes from the given namespace and for the provided inputs.",
"description" : "Only the ClassNameKey is returned by default. Set the \"full_class_definition\" query parameter to true for fetching the full class definition. By default, the full class definition returns the attributes of the given class. You can manage whether to return the attributes and which attributes to return by using the query parameters.",
"operationId" : "getClassesWithArchiveInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "When this parameter is set, it returns CDM classes from provided namespace only.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "relationship_endpoint_class",
"in" : "query",
"description" : "When this query parameter is set, it returns only the relationship classes which has one of its endpoint as specified with this query parameter.",
"required" : false,
"type" : "string"
}, {
"name" : "superclass",
"in" : "query",
"description" : "When this query parameter is set, it returns immediate child classes of the given class.",
"required" : false,
"type" : "string",
"x-example" : "BMC.CORE:BMC_BaseElement"
}, {
"name" : "hidden_classes",
"in" : "query",
"description" : "Determines whether to return the hidden classes.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "class_characteristics",
"in" : "query",
"description" : "Specifies the class characteristics/custom characteristics in JSON form. Returns only the classes that has the specified characteristic is set.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"FINAL\":1, \"100050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"FINAL\":1, \"100050\":\"BMC.SIM\"}"
}, {
"name" : "full_class_definition",
"in" : "query",
"description" : "Determines whether to return the full class definition. Returns the ClassNameKey when you set this query parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attributes",
"in" : "query",
"description" : "Determines whether to return attributes along with the class. This parameter is ignored when you set the \"full_class_definition\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : true,
"enum" : [ "[true", "false]" ]
}, {
"name" : "hidden_attributes",
"in" : "query",
"description" : "Determines whether to return hidden attributes. This parameter is ignored when you set the \"attributes\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "derived_attributes",
"in" : "query",
"description" : "Determines whether to return derived attributes. This parameter is ignored you set the \"attributes\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attribute_characteristics",
"in" : "query",
"description" : "Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when \"attributes\" query parameter is set to false",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
}, {
"name" : "sort_by_name",
"in" : "query",
"description" : "Specifies whether result should be sorted by class namespace/class name.",
"required" : false,
"type" : "boolean",
"default" : false
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CMDBClass"
}
}
}
}
}
},
"/cmdb/v1.0/arserverinfo/{serverInfoParam}" : {
"get" : {
"tags" : [ "Resource for fetching AR server information map" ],
"summary" : "Get server info by server info param",
"description" : "",
"operationId" : "getARServerInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "serverInfoParam",
"in" : "path",
"description" : "comma separated server info values to retrieve",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/AR Server information"
}
}
}
}
},
"/cmdb/v1.0/attributes/{namespace}/{className}" : {
"get" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Returns multiple attributes based on the inputs from the given class.",
"description" : "By default it returns non-hidden non-derived attributes. Set appropriate query parameters to fetch specific attributes.",
"operationId" : "getMultipleAttributes",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "hidden_attributes",
"in" : "query",
"description" : "Determines whether to return hidden attributes.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "derived_attributes",
"in" : "query",
"description" : "Determines whether to return derived attributes. This parameter is ignored when query parameter \"attribute_names\" is set to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attribute_names",
"in" : "query",
"description" : "Comma separated attribute names. When this parameter is set, it returns the attributes having name specified here.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "attribute_characteristics",
"in" : "query",
"description" : "Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
}, {
"name" : "root_class_attributes_only",
"in" : "query",
"description" : "Determines whether to return only root class attributes.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Attribute"
}
}
}
}
},
"post" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Creates multiple attributes for the given class.",
"description" : "Creates multiple attributes for the given class. It is optional to provide the ClassNameKey for the attributes belonging to the request body. But when you provide the ClassNameKey in request body, it should match with the one provided in the URL.",
"operationId" : "createMultipleAttribute",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which the attributes belong.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attributes belong.",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Deletes multiple attributes from the given class.",
"description" : "Deletes attributes provided with name from the given class.",
"operationId" : "deleteMultipleAttributes",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which the attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of class to which the attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "attribute_names",
"in" : "query",
"description" : "Comma separated attribute names to be deleted.",
"required" : true,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "option",
"in" : "query",
"description" : "Delete option.",
"required" : false,
"type" : "string",
"default" : "NONE"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Modifies provided attributes from the given class.",
"description" : "Modifies the attributes with updated definition provided in request body. The request body need not to provide full attribute definition; For example, if limit of an attribute is modified then need not to provide existing definition of characteristics, custom characteristics etc. You can rename the attribute by specifying existing attribute name in URL and new name to \"new_name\" parameter in request body.",
"operationId" : "setMultipleAttributes",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/attributes/{namespace}/{className}/{attributeName}" : {
"get" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Returns attribute that has the provided name and from the given class",
"description" : "Returns attribute having that has the name and from the given class",
"operationId" : "getAttribute",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "attributeName",
"in" : "path",
"description" : "Attribute name to be returned",
"required" : true,
"type" : "string",
"x-example" : "Domain"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Attribute"
}
}
}
},
"post" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Creates the attribute",
"description" : "Creates the attribute with definition provided in the request body. It is optional to provide the ClassNameKey for the attribute belonging to the request body. But when you provide the ClassNameKey in request body, it should match with the one provided in the URL.",
"operationId" : "createAttribute",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "attributeName",
"in" : "path",
"description" : "Attribute name to be created",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Deletes the given attribute",
"description" : "Deletes the given attribute.",
"operationId" : "deleteAttribute",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "attributeName",
"in" : "path",
"description" : "Attribute name to be deleted",
"required" : true,
"type" : "string"
}, {
"name" : "option",
"in" : "query",
"description" : "Delete option.",
"required" : false,
"type" : "string",
"default" : "NONE"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Attribute(s) Create Read Update Delete Operations." ],
"summary" : "Modifies the attribute",
"description" : "Modifies the attributes with updated definition provided in request body. The request body need not to provide full attribute definition; For example, if limit of an attribute is modified then need not to provide existing definition of characteristics, custom characteristics etc. You can rename the attribute by specifying existing attribute name in URL and new name to \"new_name\" parameter in request body.",
"operationId" : "setAttribute",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of class to which attribute belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "attributeName",
"in" : "path",
"description" : "Name of attribute being modified.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/bulk" : {
"post" : {
"tags" : [ "Bulk Instances Get, Update and Delete." ],
"summary" : "Supports for Bulk API with instances in the request body.",
"description" : "Supports Bulk API with Mutiple Instances Create, Update and Delete for Instance list objects in request body. Supports bulk API with multiple CRUD operations for an instance list objects in the request body.",
"operationId" : "bulk",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The operations and inputs required for operating bulk API.",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Bulk Operation."
}
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for output of Bulk Operaions."
}
}
}
}
}
},
"/cmdb/v1.0/ci_audit_info/{namespace}/{className}/{instanceId}" : {
"get" : {
"tags" : [ "CI Audit APIs." ],
"summary" : "Get list Audit Informaion.",
"description" : "",
"operationId" : "getAuditInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "instanceId",
"in" : "path",
"description" : "InstanceId of the class",
"required" : true,
"type" : "string"
}, {
"name" : "sort",
"in" : "query",
"description" : "Sort name with which the Logs need to be sorted. If value for this is not provided,date sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+action", "-action", "+date", "-date", "+user", "-user" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Plugin need to be retrieved.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum number of record to be retrieved, used in conjunction with offset.",
"required" : false,
"type" : "string",
"default" : "500"
}, {
"name" : "include_related_records",
"in" : "query",
"description" : "Include Related Audit Records",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of AuditInfo to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of AuditInfo to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AuditInfo"
}
}
}
}
}
},
"/cmdb/v1.0/cisubscription/changedcis/{subscriberId}/{transactionId}" : {
"get" : {
"tags" : [ "ChangeCIs." ],
"summary" : "Get Changed CIs by subscriberId for a transaction.",
"description" : "Get ChangeCIs by subscriberId for a transaction.",
"operationId" : "getChangedCIs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "subscriberId",
"in" : "path",
"description" : "subscriberId for which ChangeCIs need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "transactionId",
"in" : "path",
"description" : "transactionId for which ChangeCIs need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "pageindex",
"in" : "query",
"description" : "pageIndex of the result need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 1,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Notification"
}
}
}
}
},
"/cmdb/v1.0/classes" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Returns the list of CDM classes for given inputs or returns a CDM class based on the given class ID.",
"description" : "Use \"class_id\" query parameter to retrieve class based on class ID. When you set the \"class_id\" query parameter, other query parameters for filtering the return class are ignored. By default, it returns the ClassNameKey. Set the \"full_class_definition\" query parameter to true for obtaining the full class definition. By default, the full class definition is returns the attributes of the given class. You can manage whether to return the attributes and which attributes to be returned, by using the query parameters.",
"operationId" : "getClasses",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "relationship_endpoint_class",
"in" : "query",
"description" : "When this query parameter is set, it returns only relationship classes. The relationship classes has one of the endpoint as specified with this query parameter. This parameter is ignored when \"class_id\" query parameter is set.",
"required" : false,
"type" : "string"
}, {
"name" : "superclass",
"in" : "query",
"description" : "When this query parameter is set, it returns the immediate child classes of the given class. This parameter is ignored when \"class_id\" query parameter is set.",
"required" : false,
"type" : "string",
"x-example" : "BMC.CORE:BMC_BaseElement"
}, {
"name" : "hidden_classes",
"in" : "query",
"description" : "Determines whether to return hidden classes. This parameter is ignored when \"class_id\" query parameter is set.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "class_characteristics",
"in" : "query",
"description" : "Specifies the class characteristics/custom characteristics in JSON form. Returns only the classes that has the specified characteristic is set. This parameter is ignored when \"class_id\" query parameter is set.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"FINAL\":1, \"100050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"FINAL\":1, \"100050\":\"BMC.SIM\"}"
}, {
"name" : "class_id",
"in" : "query",
"description" : "Use this query parameter when you want to fetch the class, based on class ID. When this query parameter is set, following parameters are ignored: relationship_endpoint_class/superclass/hidden_classes/class_characteristics",
"required" : false,
"type" : "string"
}, {
"name" : "full_class_definition",
"in" : "query",
"description" : "Determines whether to return the full class definition. Returns the ClassNameKey when you set this parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attributes",
"in" : "query",
"description" : "Determines whether to return attributes along with the class. This parameter is ignored when you set the \"full_class_definition\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : true,
"enum" : [ "[true", "false]" ]
}, {
"name" : "hidden_attributes",
"in" : "query",
"description" : "Determines whether to return hidden attributes. This parameter is ignored when you set the \"attributes\" query parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "derived_attributes",
"in" : "query",
"description" : "Determines whether to return derived attributes. This parameter is ignored you set the \"attributes\" query parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attribute_characteristics",
"in" : "query",
"description" : "Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when \"attributes\" query parameter is set to false.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
}, {
"name" : "sort_by_name",
"in" : "query",
"description" : "Specifies whether result should be sorted by class namespace/class name.",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "class_type",
"in" : "query",
"description" : "Specifies the type of classes that need to be fetched.",
"required" : false,
"type" : "string",
"enum" : [ "REGULAR", "RELATIONSHIP", "FEDERATED", "FEDERATED_RELATIONSHIP" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CMDBClass"
}
}
}
}
}
},
"/cmdb/v1.0/classes/archiveinfo/age" : {
"get" : {
"tags" : [ "CMDB Class Archive Operations." ],
"summary" : "Returns global and custom archive age",
"description" : "Returns global and custom archive age.",
"operationId" : "getClassArchiveAgeInfo",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CMDBClassArchiveAgeInfo"
}
}
}
},
"patch" : {
"tags" : [ "CMDB Class Archive Operations." ],
"summary" : "Update Archive Age Info.",
"description" : "Update Archive Age Info.",
"operationId" : "updateClassArchiveAgeInfo",
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/classes/archiveinfo/{namespace}/{className}" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Returns a CDM class archive info for given namespace name and class name",
"description" : "Returns the archive info of Archive Form Name and Archive Qualification for the given class.",
"operationId" : "getClassArchiveinfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name to be returned back.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CMDBClassArchiveInfo"
}
}
}
},
"patch" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Sets a CDM class archive info for given namespace name and class name",
"description" : "Sets the archive info of Archive Form Name and Archive Qualification for the given class.",
"operationId" : "setClassArchiveinfo",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/classes/relationships" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Returns a list of applicable relationships for given source and target class",
"description" : "Returns a list of applicable relationships for given source and target class",
"operationId" : "getApplicableRelationships",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "source_class",
"in" : "query",
"description" : "Source Class for the relationships to return",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE:BMC_ApplicationService"
}, {
"name" : "target_class",
"in" : "query",
"description" : "Target Class for the relationships to return",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE:BMC_ComputerSystem"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/class_name_key"
}
}
}
}
}
},
"/cmdb/v1.0/classes/{namespace}" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Returns the list of CDM classes from the given namespace and for the provided inputs.",
"description" : "Only the ClassNameKey is returned by default. Set the \"full_class_definition\" query parameter to true for fetching the full class definition. By default, the full class definition returns the attributes of the given class. You can manage whether to return the attributes and which attributes to return by using the query parameters.",
"operationId" : "getClasses",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "When this parameter is set, it returns CDM classes from provided namespace only.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "relationship_endpoint_class",
"in" : "query",
"description" : "When this query parameter is set, it returns only the relationship classes which has one of its endpoint as specified with this query parameter.",
"required" : false,
"type" : "string"
}, {
"name" : "superclass",
"in" : "query",
"description" : "When this query parameter is set, it returns immediate child classes of the given class.",
"required" : false,
"type" : "string",
"x-example" : "BMC.CORE:BMC_BaseElement"
}, {
"name" : "hidden_classes",
"in" : "query",
"description" : "Determines whether to return the hidden classes.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "class_characteristics",
"in" : "query",
"description" : "Specifies the class characteristics/custom characteristics in JSON form. Returns only the classes that has the specified characteristic is set.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"FINAL\":1, \"100050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"FINAL\":1, \"100050\":\"BMC.SIM\"}"
}, {
"name" : "full_class_definition",
"in" : "query",
"description" : "Determines whether to return the full class definition. Returns the ClassNameKey when you set this query parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attributes",
"in" : "query",
"description" : "Determines whether to return attributes along with the class. This parameter is ignored when you set the \"full_class_definition\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : true,
"enum" : [ "[true", "false]" ]
}, {
"name" : "hidden_attributes",
"in" : "query",
"description" : "Determines whether to return hidden attributes. This parameter is ignored when you set the \"attributes\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "derived_attributes",
"in" : "query",
"description" : "Determines whether to return derived attributes. This parameter is ignored you set the \"attributes\" query parameter to false.",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attribute_characteristics",
"in" : "query",
"description" : "Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when \"attributes\" query parameter is set to false",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
}, {
"name" : "sort_by_name",
"in" : "query",
"description" : "Specifies whether result should be sorted by class namespace/class name.",
"required" : false,
"type" : "boolean",
"default" : false
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CMDBClass"
}
}
}
}
}
},
"/cmdb/v1.0/classes/{namespace}/{className}" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Returns a CDM class for given namespace name and class name",
"description" : "Returns the attribute of the given class by default. You can control whether to return attributes and which attributes to be returned by using other query parameters",
"operationId" : "getClass",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name to be returned back.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
}, {
"name" : "attributes",
"in" : "query",
"description" : "Determines whether to return attributes along with the class",
"required" : false,
"type" : "boolean",
"default" : true,
"enum" : [ "[true", "false]" ]
}, {
"name" : "hidden_attributes",
"in" : "query",
"description" : "Determines whether to return hidden attributes. This parameter is ignored when you set the \"attributes\" query parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "derived_attributes",
"in" : "query",
"description" : "Determines whether to return derived attributes. This parameter is ignored you set the \"attributes\" query parameter to false",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "attribute_characteristics",
"in" : "query",
"description" : "Specifies the attribute characteristics/custom characteristics in JSON form. Returns only the attributes that has the specified characteristic is set. This parameter is ignored when \"attributes\" query parameter to false",
"required" : false,
"type" : "array",
"items" : {
"type" : "string",
"example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
},
"collectionFormat" : "multi",
"x-example" : "{\"NAMESPACE\":\"BMC.CORE\", \"300050\":\"BMC.SIM\"}"
}, {
"name" : "display_information",
"in" : "query",
"description" : "Determines whether to return display information for class",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
}, {
"name" : "class_owner",
"in" : "query",
"description" : "Determines whether to return owner of the class",
"required" : false,
"type" : "boolean",
"default" : false,
"enum" : [ "[true", "false]" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/CMDBClass"
}
}
}
},
"post" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Creates the class",
"description" : "Creates the class with definition provided in request body. It is optional to provide the ClasNameKey information in request body but, when the Classnamekey is provided, it should match with the one given in the URL.",
"operationId" : "createClass",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to be created",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Deletes a class as per the inputs given.",
"description" : "Deletes the class and its attributes, data, and child classes based on the delete option specified in the \"option\" query parameter.",
"operationId" : "deleteClass",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname of the class to be deleted",
"required" : true,
"type" : "string"
}, {
"name" : "option",
"in" : "query",
"description" : "Delete option.",
"required" : false,
"type" : "string",
"default" : "NONE",
"enum" : [ "[NONE", "WITH_DATA", "WITH_ALL_DEPENDENCIES]" ]
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"summary" : "Modifies the given class.",
"description" : "Modifies the given class with the modified definition provided in the request body. The request body need not to provide full class definition; For example, if class index is modified then need not to provide existing definition of characteristics, custom characteristics etc. To rename the class, class name in URL should have the existing name and the body should have a new name.",
"operationId" : "setClass",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which class belong",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name being modified",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/classinfo/allowedrelationships/{namespace}/{className}" : {
"get" : {
"tags" : [ "CMDB Class Information" ],
"summary" : "Returns a collection of relationships the given class can participate in.",
"description" : "Returns a collection of relationships the given class can participate in.",
"operationId" : "getClassAllowedRelationships",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name for which CI mappings need to be retrieved.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ClassAllowedRelationship"
}
}
}
}
},
"/cmdb/v1.0/classinfo/cimappings/{namespace}/{className}" : {
"get" : {
"tags" : [ "CMDB Class Information" ],
"summary" : "Returns CI Mappings Information for a given class.",
"description" : "Returns CI Mappings Information for a given class.",
"operationId" : "getClassCIMappings",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name for which CI mappings need to be retrieved.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ClassCIMapping"
}
}
}
}
},
"/cmdb/v1.0/classinfo/normalizedrelations/{namespace}/{className}" : {
"get" : {
"tags" : [ "CMDB Class Information" ],
"summary" : "Returns list of normalized relationship references",
"description" : "Returns list of normalized relationship references",
"operationId" : "getClassAllowedRelations",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name for which CI mappings need to be retrieved.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ClassNormalizedRelationship"
}
}
}
}
},
"/cmdb/v1.0/classqueries/{namespace}/{className}" : {
"get" : {
"tags" : [ "CMDB Class Queries operations" ],
"summary" : "Enables you to retrieve a list of instances for the specified class against a stored list of queries.",
"description" : "You can retrieve the required instance by using the querybypath/{namespace}/{className} parameters.",
"operationId" : "getQueryResultsForClass",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC_ComputerSystem"
}, {
"name" : "attribute_values",
"in" : "query",
"required" : false,
"type" : "string, use attribute value "
}, {
"name" : "category",
"in" : "query",
"description" : "Category for which the class queries need to be executed.",
"required" : true,
"type" : "string"
}, {
"name" : "return_single",
"in" : "query",
"description" : "Returns a single matching value for the qualification. Example: return_single=true",
"required" : false,
"type" : "boolean",
"default" : false
},{
"name" : "dataset_id",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "BMC.ASSET"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain for Query By Path response"
}
}
}
}
},
"/cmdb/v1.0/command" : {
"post" : {
"tags" : [ "Resource for operations like Start, Stop etc." ],
"summary" : "Executes the command specified in the body with required parameters.",
"description" : "Available commands are: START_NE_JOB, CANCEL_NE_JOB, START_RE_JOB, CANCEL_RE_JOB.",
"operationId" : "post",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "JSON containing the command with required parameters.",
"required" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/config/components/{applName}" : {
"get" : {
"tags" : [ "Centralized Configuration Settings." ],
"summary" : "Get all components.",
"description" : "Gets all the components for a given application.",
"operationId" : "getComponents",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Component"
}
}
}
}
},
"/cmdb/v1.0/config/midtierurlinfo" : {
"get" : {
"tags" : [ "Centralized Configuration Settings." ],
"operationId" : "getMidtierUrlInfo",
"produces" : [ "application/json" ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/config/{applName}/component/{componentName}" : {
"get" : {
"tags" : [ "Centralized Configuration Settings." ],
"summary" : "Get Configuration.",
"description" : "Gets the configuration for a given application under the given component.",
"operationId" : "getConfig",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applName",
"in" : "path",
"description" : "Application name for which configurations need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "componentName",
"in" : "path",
"description" : "Component name corresponding to application for which configurations need to be retrieved",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Centralized Configuration Settings"
}
}
}
},
"patch" : {
"tags" : [ "Centralized Configuration Settings." ],
"summary" : "Updates the ConfigurationSetting.",
"description" : "Updates the ConfigurationSetting with definition provided in request body.",
"operationId" : "updateSettings",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applName",
"in" : "path",
"description" : "Application name for configurations need to be updated",
"required" : true,
"type" : "string"
}, {
"name" : "componentName",
"in" : "path",
"description" : "Component name corresponding to application for which configurations need to be updated",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The configuration setting to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Centralized Configuration Settings"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dashboardconfig" : {
"get" : {
"tags" : [ "Dashboard Configuration Settings." ],
"summary" : "Get Dashboard Utility Run Schedule.",
"description" : "You can get Dashboard Utility Run Schedule using /dashboardconfig.",
"operationId" : "getDashboardSchedule",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/dashboard_schedule_list"
}
}
}
}
},
"post" : {
"tags" : [ "Dashboard Configuration Settings." ],
"summary" : "Create Dashboard Utility Run Schedule.",
"description" : "you can create Dashboard Utility Run Schedule by using /dashboardconfig",
"operationId" : "createDashboardSchedule",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/dashboard_schedule_list"
}
}
}
}
}
},
"/cmdb/v1.0/dashboardconfig/completeness" : {
"get" : {
"tags" : [ "Completeness Configurations." ],
"summary" : "Get Completeness configs for given all classes.",
"description" : "You can retrieve the required completeness config by using the /{dashboardconfig}/completeness/ parameters.",
"operationId" : "getCompleteness",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Id Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Id Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Completeness Configs."
}
}
}
},
"post" : {
"tags" : [ "Completeness Configurations." ],
"summary" : "Create Id Rule.",
"description" : "You can create the required completeness config by using the /{dashboardconfig}/{completeness} parameters.",
"operationId" : "createCompletenessConfig",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The config object for which completenes config needs to be created",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Completeness Config"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dashboardconfig/completeness/{instanceId}" : {
"get" : {
"tags" : [ "Completeness Configurations." ],
"summary" : "Get Completeness Config for given instanceId.",
"description" : "You can retrieve the required completeness config by using the /{dashboardconfig}/completeness/{instanceId} parameters.",
"operationId" : "getCompletenessConfigsForGivenInstanceId",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "instanceId",
"in" : "path",
"description" : "instanceId for which to fetch Id Rule Groups.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Id Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Id Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Completeness Configs."
}
}
}
},
"delete" : {
"tags" : [ "Completeness Configurations." ],
"summary" : "Delete Completeness config for given class name and attribute name.",
"description" : "You can update the required Id Rule Group by using the {completeness}/{namespace}/{className}/{attributeName} parameters.",
"operationId" : "deleteCompletenessConfig",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "instanceId",
"in" : "path",
"description" : "Namespace for which configuration needs to be updated.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Completeness Configurations." ],
"summary" : "Update Completeness config for given class name and attribute name.",
"description" : "You can update the required Id using the {completeness}/{instanceId} parameters.",
"operationId" : "updateCompletenessConfig",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "instanceId",
"in" : "path",
"description" : "Instance id for which configuration needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Completeness Config attribute that needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Completeness Config"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dashboardconfig/completeness/{namespace}/{className}" : {
"get" : {
"tags" : [ "Completeness Configurations." ],
"summary" : "Get Completeness Config for given class.",
"description" : "You can retrieve the required completeness config by using the /{dashboardconfig}/completeness/{namespace}/{className} parameters.",
"operationId" : "getCompletenessConfigsForGivenClass",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace for which the Id Rule Groups need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname for which to fetch Id Rule Groups.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Id Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Id Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Completeness Configs."
}
}
}
}
},
"/cmdb/v1.0/dataflow/summary" : {
"get" : {
"tags" : [ "Returns information on dataflow component" ],
"summary" : "Returns Datasource Data Flow.",
"description" : "You can retrieve the All Datasource, successful CIs, Failed CIs and CI updates by using the /{health}/{datasources}/{dataflow} parameters.",
"operationId" : "getDataFlowSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Specifies the name of the datasource Id for which statistics to be retrieved.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Dataflow summary"
}
}
}
}
},
"/cmdb/v1.0/datasets" : {
"get" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Get All Datasets.",
"description" : "Returns all datasets.",
"operationId" : "getDatasetsList",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of datasets to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the datasets to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "id",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on Core Dataset Id. Server will return entries having given string present in CoreDatasetId",
"required" : false,
"type" : "string"
}, {
"name" : "return_overlay_datasets",
"in" : "query",
"description" : "Whether to return overlay datasets",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "sort",
"in" : "query",
"description" : "Sort information, separated by comma when sorting is to be done on multiple columns. For ascending order, preceed the column name with \"+\" or use just the column name. For descending order, preceed the column name with \"-\".",
"required" : false,
"type" : "string",
"default" : "id",
"x-example" : "name",
"enum" : [ "+id", "-id", "id" ]
}, {
"name" : "unmapped_datasets_only",
"in" : "query",
"description" : "Whether to return overlay datasets",
"required" : false,
"type" : "boolean",
"default" : false
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"post" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Create Dataset.",
"description" : "Create dataset.",
"operationId" : "createDataset",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Dataset object to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Dataset"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Dataset"
}
}
}
}
}
},
"/cmdb/v1.0/datasets/list/all" : {
"get" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"operationId" : "getAllDatasets",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "includeSandbox",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "id",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/datasets/permissions/groups" : {
"get" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Get dataset permissions for groups.",
"description" : "Returns the list of groups permissions applicable for datasets.",
"operationId" : "getDatasetPermissionGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Filter string to filter by name for group permissions to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of group permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the group permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/permissions"
}
}
}
}
}
},
"/cmdb/v1.0/datasets/permissions/names" : {
"get" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Get dataset permission names.",
"description" : "Returns the list of permissions for given permission ids.",
"operationId" : "getDatasetPermissionNames",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "permission_ids",
"in" : "query",
"description" : "Comma separated list of dataset permissions Ids.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/permissions"
}
}
}
}
}
},
"/cmdb/v1.0/datasets/permissions/roles" : {
"get" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Get dataset permissions for roles.",
"description" : "Returns the list of role permissions configured for CMDB application.",
"operationId" : "getDatasetPermissionRoles",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Filter string to filter by name for role permissions to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of role permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the role permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/permissions"
}
}
}
}
}
},
"/cmdb/v1.0/datasets/{id}" : {
"get" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Get Single Dataset.",
"description" : "Returns dataset based on CoreDatasetId.",
"operationId" : "getDataset",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Dataset"
}
}
}
}
},
"patch" : {
"tags" : [ "Dataset Create Read Update Operations" ],
"summary" : "Update Dataset Permission.",
"description" : "Only dataset permissions can be updated.",
"operationId" : "updateDatasetPermission",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Dataset Id of dataset which needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Dataset object in which permissions needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Dataset"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
},
"/cmdb/v1.0/datasources" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Get All Datasource.",
"description" : "Returns all datasource.",
"operationId" : "getAllDatasources",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Datasources need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Datasources to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated field names with which the Datasources should be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+id", "-id", "+name", "-name", "+provider_type", "-provider_type", "+related_dataset_id", "-related_dataset_id" ]
}, {
"name" : "related_dataset_id",
"in" : "query",
"description" : "Filter on Dataset Id.Server will return entries having given string present in related dataset id",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"post" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Create datasource.",
"description" : "Create datasource.",
"operationId" : "createDatasource",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Datasource Object to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for datasource"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for datasource"
}
}
}
}
},
"/cmdb/v1.0/datasources/cisummary" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Returns CI summary for provided data sources.",
"description" : "In case it could not find data source with given name, it will return error.",
"operationId" : "getCISummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "query",
"description" : "Specifies the name of the datasource for which statistics to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "related_dataset_id",
"in" : "query",
"description" : "Specifies the id of the related dataset for which statistics is to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the data source statistics to be retrived.",
"required" : false,
"type" : "string",
"default" : "AS_OF_TODAY"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for summary of instances in given datasource"
}
}
}
}
},
"/cmdb/v1.0/datasources/failedcis" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Returns failed CI details for given dataset.",
"description" : "In case it could not find data source with given name, it will return error.",
"operationId" : "getFailedCIs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "query",
"description" : "Specifies the name of the datasource for which failed CIs are to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "related_dataset_id",
"in" : "query",
"description" : "Specifies the related dataset id for which failed CIs are to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "failure_type",
"in" : "query",
"description" : "Specifies the failure type. It will return instances which are failed with specified type only",
"required" : true,
"type" : "string",
"enum" : [ "[FAILED_TO_NORMALIZE", "FAILED_TO_IDENTIFY", "FAILED_TO_MERGE]" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the failed CIs are to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximium number of failed CIs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the failed CIs are to be retrieved.",
"required" : false,
"type" : "string",
"default" : "AS_OF_TODAY"
}, {
"name" : "ci_type",
"in" : "query",
"description" : "Type of CI, Relationship or CI for which to fetch failed instances. If the CI Type is not provided, both CI and Relationships types would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "CI", "RELATIONSHIP" ]
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated field names with which the Datasources should be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+ci_name", "-ci_name" ]
}, {
"name" : "ci_name",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on CI name. Server will return entries having given string present in ci name",
"required" : false,
"type" : "string"
}, {
"name" : "class_name",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on Class name. Server will return entries having given string present in class name",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for failed CIs for given data source"
}
}
}
}
},
"/cmdb/v1.0/datasources/statistics" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Returns statistics for all data sources.",
"description" : "It includes even the datasets for whcih there is not associated datasource. The number of data sources returned depends on value set for query paramters offset and limit",
"operationId" : "getDataSourceStatistics",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the data source statistics to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Number of data source statistics to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "state",
"in" : "query",
"description" : "State of the Datasources that should be retrieved",
"required" : false,
"type" : "string",
"enum" : [ "GOOD", "BAD" ]
}, {
"name" : "sort",
"in" : "query",
"description" : "Sort information, separated by comma when sorting is to be done on multiple columns. For ascending order, preceed the column name with \"+\" or use just the column name. For descending order, preceed the column name with \"-\".",
"required" : false,
"type" : "string",
"x-example" : "name",
"enum" : [ "+name", "-name", "+related_dataset_id", "-related_dataset_id", "+provider_type", "-provider_type", "+total_num_of_cis", "-total_num_of_cis", "+related_dataset_id", "-related_dataset_id", "+num_cis_pending_to_normalize", "-num_cis_pending_to_normalize", "+num_cis_failed_to_normalize", "-num_cis_failed_to_normalize", "+num_cis_pending_to_identify", "-num_cis_pending_to_identify", "+num_cis_pending_to_merge", "-num_cis_pending_to_merge", "+num_cis_failed_to_merge", "-num_cis_failed_to_merge", "+num_cis_failed_to_identify", "-num_cis_failed_to_identify", "+num_cis_failed_to_reconcile", "-num_cis_failed_to_reconcile", "+num_cis_pending_to_reconcile", "-num_cis_pending_to_reconcile" ]
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the data source statistics to be retrived.",
"required" : false,
"type" : "string",
"default" : "AS_OF_TODAY"
}, {
"name" : "name",
"in" : "query",
"description" : "Filter on Datasource Name.Server will return entries having given string present in datasource name",
"required" : false,
"type" : "string"
}, {
"name" : "datasets_without_datasource",
"in" : "query",
"description" : "Filter on datasets without datasources. Server will return entries which do not have datasource attached.",
"required" : false,
"type" : "boolean"
}, {
"name" : "related_dataset_id",
"in" : "query",
"description" : "Filter on Dataset Id.Server will return entries having given string present in related dataset id",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DataSourceStatisticsList"
}
}
}
}
},
"/cmdb/v1.0/datasources/statistics/{dataSourceId}" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Returns statistics for provided data sources.",
"description" : "In case it could not find data source with given name, it will return error.",
"operationId" : "getDataSourceStatistics",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataSourceId",
"in" : "path",
"description" : "Specifies the name of the datasource Id for which statistics to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the data source statistics to be retrived.",
"required" : false,
"type" : "string",
"default" : "AS_OF_TODAY"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for DataSource"
}
}
}
}
},
"/cmdb/v1.0/datasources/statisticssummary" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Returns statistics summary for all data sources.",
"description" : "It includes even the datasets for which there is not associated datasource.",
"operationId" : "getDataSourceStatisticsSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the data source statistics to be retrived.",
"required" : false,
"type" : "string",
"default" : "AS_OF_TODAY"
}, {
"name" : "name",
"in" : "query",
"description" : "Filter on Datasource Name.Server will return entries having given string present in datasource name",
"required" : false,
"type" : "string"
}, {
"name" : "related_dataset_id",
"in" : "query",
"description" : "Filter on Dataset Id.Server will return entries having given string present in related dataset id",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/DataSourceStatisticsSummary"
}
}
}
}
},
"/cmdb/v1.0/datasources/{dataSourceId}" : {
"get" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Get Single Datasource.",
"description" : "Returns datasource based on datasource Id.",
"operationId" : "getDatasource",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataSourceId",
"in" : "path",
"description" : "datasourceId of the datasource that needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the failed CIs are to be retrieved.",
"required" : false,
"type" : "string",
"default" : "AS_OF_TODAY"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for DataSource"
}
}
}
},
"patch" : {
"tags" : [ "Datasource Create, Read, Update, Delete, Statistics operations." ],
"summary" : "Update Datasource.",
"description" : "Update Datasource.",
"operationId" : "updateDatasource",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "dataSourceId",
"in" : "path",
"description" : "DatasourceId for which the datasource needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Datasource object to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for datasource"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries" : {
"get" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "Get list of all DSM category type of Graphical Search queries.",
"description" : "",
"operationId" : "getDsmQueries",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ci_instance_id",
"in" : "query",
"description" : "CI Instance ID for which the list of DSM Graphical Search Query to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "include_query",
"in" : "query",
"description" : "Flag to include query definition in result. If value for this is not provided, query definition would not be included.",
"required" : false,
"type" : "boolean",
"default" : false
}, {
"name" : "query_type",
"in" : "query",
"description" : "Query type for which the list of Graphical Search Query to be retrieved. If value for this is not provided, All Graphical Search queries would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "GLOBAL", "PERSONAL" ]
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries/associate" : {
"post" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "Associate DSM category type of Graphical Search Query to instance.",
"description" : "",
"operationId" : "associateDsmQuery",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "ci_instance_id",
"in" : "query",
"description" : "Instance Id to Associate DSM Graphical Search Query.",
"required" : true,
"type" : "string"
}, {
"name" : "queryName",
"in" : "query",
"description" : "Query Name to Associate DSM Graphical Search Query",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries/{instanceId}" : {
"post" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "create DSM category type of Graphical Search Query.",
"description" : "",
"operationId" : "createDsmQuery",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "CMDBSavedQuery object to be created for DSM.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CMDBSavedQuery"
}
}, {
"name" : "instanceId",
"in" : "path",
"description" : "Instance Id to create DSM Graphical Search Query.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries/{queryId}" : {
"delete" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "Delete DSM category type of Graphical Search Query.",
"description" : "",
"operationId" : "deleteCmdbSavedQuery",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "queryId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "ci_instance_id",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "Update DSM category type of Graphical Search Query.",
"description" : "",
"operationId" : "updateDsmQuery",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "queryId",
"in" : "path",
"description" : "query Id of the DSM Graphical Search Query which needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "DSM CMDBSavedQuery object to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/CMDBSavedQuery"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries/{queryName}" : {
"get" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "Get DSM category type of Graphical Search Query.",
"description" : "",
"operationId" : "getDsmQuery",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "queryName",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries/{queryName}/instances" : {
"get" : {
"tags" : [ "DSM Queries CRUD Operations." ],
"summary" : "Get list of all CI InstanceId on DSM Scan Query is Associated",
"description" : "",
"operationId" : "getListOfInstanceId",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "queryName",
"in" : "path",
"description" : "Query Name for the list of Instance Ids to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries_scan_config" : {
"get" : {
"tags" : [ "DSM Queries Scan Configurations." ],
"summary" : "Get list of all Dynamic Service Modeling queries scan configurations.",
"description" : "Retrieves all entries from 'DSM:ScanConfig' form.",
"operationId" : "getScanConfig",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ci_instance_id",
"in" : "query",
"description" : "InstanceId to retrive Scan Config for CI. If value for this is not provided, All Scan Config would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "ci_type",
"in" : "query",
"description" : "CI type for which the list of scan config to be retrieved. If value for this is not provided, All scan config would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "BUSINESS", "TECHNICAL", "APPLICATION", "OTHER" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the instances need to be retrieved.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum number of CIs to be retrieved, used in conjunction with offset.",
"required" : false,
"type" : "string",
"default" : "500"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DsmQueriesScanConfigModel"
}
}
}
}
},
"post" : {
"tags" : [ "DSM Queries Scan Configurations." ],
"summary" : "Create DSM Scan Config entry.",
"description" : "",
"operationId" : "createScanConfig",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "dsmQueriesScanConfigModel object to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DsmQueriesScanConfigModel"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/dsm/queries_scan_config/{instanceId}" : {
"delete" : {
"tags" : [ "DSM Queries Scan Configurations." ],
"summary" : "Delete DSM Scan Config entry.",
"description" : "",
"operationId" : "deleteScanConfig",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "instanceId",
"in" : "path",
"description" : "instanceId to delete scan config.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "DSM Queries Scan Configurations." ],
"summary" : "Update DSM Scan Config entry.",
"description" : "",
"operationId" : "updateScanConfig",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "dsmQueriesScanConfigModel object to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/DsmQueriesScanConfigModel"
}
}, {
"name" : "instanceId",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/classes" : {
"post" : {
"tags" : [ "REST Resource for Federation Classes" ],
"summary" : "Creates Federation Class.",
"description" : "Creates Federation Class.",
"operationId" : "createFederationClass",
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
}
},
"/cmdb/v1.0/federation/classes/attributes_mapping/{namespace}/{className}" : {
"patch" : {
"tags" : [ "REST Resource for Federation Classes" ],
"summary" : "Modifies provided attributes from the given federated class.",
"description" : "Modifies the attributes with updated definition provided in request body. The request body need not to provide full attribute definition; For example, if limit of an attribute is modified then need not to provide existing definition of characteristics, custom characteristics etc. You can rename the attribute by specifying existing attribute name in URL and new name to \"new_name\" parameter in request body.",
"operationId" : "editAttributes",
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name of the class to which attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC.FED"
}, {
"name" : "className",
"in" : "path",
"description" : "Class name of the class to which attributes belong",
"required" : true,
"type" : "string",
"x-example" : "BMC_FederatedBaseElement"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/definition" : {
"post" : {
"tags" : [ "Federation Manager" ],
"summary" : "Create Federation Definition.",
"description" : "Create Federation Definition.",
"operationId" : "createFederatedDefiniton",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Federated Definition which needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedDataInterface"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
},
"patch" : {
"tags" : [ "Federation Manager" ],
"summary" : "Update Federation Definition.",
"description" : "Update Federation Definition.",
"operationId" : "updateFederatedDefiniton",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Federated Definition which needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedDataInterface"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/definition/{federatedDefinitionInstanceId}" : {
"delete" : {
"tags" : [ "Federation Manager" ],
"summary" : "Delete Federation Definition.",
"description" : "Delete Federation Definition.",
"operationId" : "deleteFederatedDefinition",
"parameters" : [ {
"name" : "federatedDefinitionInstanceId",
"in" : "path",
"description" : "The Federated Link which needs to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/definitions/{federatedProductInstanceId}" : {
"get" : {
"tags" : [ "Federation Manager" ],
"summary" : "Get Federation Definitions.",
"description" : "Returns Federation Definitions.",
"operationId" : "getFederatedDefinitions",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "federatedProductInstanceId",
"in" : "path",
"description" : "FederatedProductInstanceId for which an Definition needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of federated definitions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the federated definitions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "name",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on Name. Server will return entries matching given string present in Name parameter",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedDataInterface"
}
}
}
}
}
},
"/cmdb/v1.0/federation/group" : {
"post" : {
"tags" : [ "Federation Manager" ],
"summary" : "Creates Federation Group.",
"description" : "Creates Federation Group.",
"operationId" : "createFederatedGroup",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Federated Group which needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedProduct"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
}
},
"/cmdb/v1.0/federation/groups" : {
"get" : {
"tags" : [ "Federation Manager" ],
"summary" : "Get Federation Groups.",
"description" : "Returns Federation Groups.",
"operationId" : "getFederatedGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of federated groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the federated groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "name",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on Group Name. Server will return entries having given string present in Name parameter",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/federated_groups"
}
}
}
}
}
},
"/cmdb/v1.0/federation/instance/links/{classId}/{instanceId}" : {
"get" : {
"tags" : [ "Federation Manager" ],
"summary" : "Get Federation Links.",
"description" : "Returns Federation Links.",
"operationId" : "getFederatedLinksForInstance",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "classId",
"in" : "path",
"description" : "classId for which an link needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "instanceId",
"in" : "path",
"description" : "classId for which an link needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of federated definitions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the federated definitions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Federated Link for given instance"
}
}
}
}
}
},
"/cmdb/v1.0/federation/link" : {
"post" : {
"tags" : [ "Federation Manager" ],
"summary" : "Create Federation Link.",
"description" : "Create Federation Link.",
"operationId" : "createFederatedLink",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Federated Link which needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedInterfaceLink"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
},
"patch" : {
"tags" : [ "Federation Manager" ],
"summary" : "Create Federation Link.",
"description" : "Create Federation Link.",
"operationId" : "updateFederatedLink",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Federated Link which needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedInterfaceLink"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/link/{federatedLinkInstanceId}" : {
"delete" : {
"tags" : [ "Federation Manager" ],
"summary" : "Delete Federation Link.",
"description" : "Delete Federation Link.",
"operationId" : "deleteFederatedLink",
"parameters" : [ {
"name" : "federatedLinkInstanceId",
"in" : "path",
"description" : "The Federated Link which needs to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/links/{federatedDefinitionInstanceId}" : {
"get" : {
"tags" : [ "Federation Manager" ],
"summary" : "Get Federation Links.",
"description" : "Returns Federation Links.",
"operationId" : "getFederatedLinks",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "federatedDefinitionInstanceId",
"in" : "path",
"description" : "FederatedProductInstanceId for which an Definition needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of federated definitions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the federated definitions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "name",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on Name. Server will return entries matching given string present in Name parameter",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedInterfaceLink"
}
}
}
}
}
},
"/cmdb/v1.0/federation/plugins" : {
"get" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Get list of Federation Plugins.",
"description" : "",
"operationId" : "getFederationPlugins",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Plugin need to be retrieved.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum number of Plugins to be retrieved, used in conjunction with offset.",
"required" : false,
"type" : "string",
"default" : "500"
}, {
"name" : "include_connection_string",
"in" : "query",
"description" : "Flag to get Connection String in Plugins Retrived.",
"required" : false,
"type" : "boolean",
"default" : false
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/federation_plugins"
}
}
}
},
"post" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Create Federation Plugin",
"description" : "",
"operationId" : "createFederationPlugin",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Federation Plugin Config object to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for FederationPluginConfig"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/plugins/status" : {
"get" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Get Status of Federation Plugins.",
"description" : "",
"operationId" : "getFederationPluginStatus",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/FederationPluginStatusList"
}
}
}
}
},
"/cmdb/v1.0/federation/plugins/tables/columns/{pluginId}/{tableName}" : {
"get" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Get List Of Columns For Given Plugin Name and Table Name.",
"description" : "Returns Column Details.",
"operationId" : "getVendorTableColumns",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "pluginId",
"in" : "path",
"description" : "pluginId for which list of tables needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "tableName",
"in" : "path",
"description" : "tableName for which list of columns needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Federation Vendor Table Column List"
}
}
}
}
}
},
"/cmdb/v1.0/federation/plugins/tables/{pluginId}" : {
"get" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Get List Of Vendor Tables For Given Plugin Name.",
"description" : "Returns Vendor Tables.",
"operationId" : "getVendorTables",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "pluginId",
"in" : "path",
"description" : "pluginId based on which list of columns for given table needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Federation Vendor Tables"
}
}
}
}
}
},
"/cmdb/v1.0/federation/plugins/{pluginId}" : {
"get" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Get Federation Plugin by plugin Id",
"description" : "",
"operationId" : "getFederationPlugin",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "pluginId",
"in" : "path",
"description" : "PluginId for which Plugin needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for FederationPluginConfig"
}
}
}
},
"delete" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Delete Federation Plugin",
"description" : "",
"operationId" : "deleteFederationPlugin",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "pluginId",
"in" : "path",
"description" : "PluginId for which Plugin needs to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Federation Plugins APIs." ],
"summary" : "Update Federation Plugin",
"description" : "",
"operationId" : "updateFederationPlugin",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "pluginId",
"in" : "path",
"description" : "PluginId for which Plugin needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Federation Plugin Config object to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for FederationPluginConfig"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/federation/relationships" : {
"post" : {
"tags" : [ "REST Resource for Federation Relationships" ],
"summary" : "Creates Federation Relationships.",
"description" : "Creates Federation Relationships.",
"operationId" : "createFederationRelationships",
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
}
},
"/cmdb/v1.0/graphwalk" : {
"get" : {
"tags" : [ "Graph Walk API." ],
"summary" : "Get Graph (GET).",
"description" : "Get Graph based on graph walk query.",
"operationId" : "graphWalkByGet",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "graph_walk_query",
"in" : "query",
"description" : "Graph walk query for which graph needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Graph Walk Result"
}
}
}
},
"post" : {
"tags" : [ "Graph Walk API." ],
"summary" : "Get Graph (POST).",
"description" : "Get Graph based on graph walk query.",
"operationId" : "graphWalkByPost",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Graph walk query for which graph needs to be retrieved.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Graph Walk Query"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Graph Walk Result"
}
}
}
}
},
"/cmdb/v1.0/health/datasources/dataflow" : {
"get" : {
"tags" : [ "CMDB Health Exceptions Summary and Details." ],
"summary" : "Returns Datasource Data Flow.",
"description" : "You can retrieve the All Datasource, successful CIs, Failed CIs and CI updates by using the /{health}/{datasources}/{dataflow} parameters.",
"operationId" : "getDataFlowSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Specifies the dataset Id for which statistics to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "activity_type",
"in" : "query",
"description" : "Activity for which the data flow Summary needs to be retrieved. If value for this is not provided, summary for all activities would be retrieved.",
"required" : false,
"type" : "string",
"enum" : [ "MERGE", "COMPARE", "IDENTIFY", "RENAME", "EXECUTE", "COPY", "PURGE", "DELETE" ]
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the all datasource, successful CIs, failed CIs and CI updates to be retrived.",
"required" : false,
"type" : "string",
"default" : "TODAY"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Dataflow summary"
}
}
}
}
},
"/cmdb/v1.0/health/details/completeness" : {
"get" : {
"tags" : [ "CMDB Health Exceptions Summary and Details." ],
"summary" : "Returns details for completeness exceptions.",
"description" : "You can get completeness health exception details records by using health/details/completeness/{offset}/{limit}/{sort}/{filterCIName}/{filterClassName}",
"operationId" : "getCompletenessDetails",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the exception details recto be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Number of exceptions details to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "The Exception Details can be sorted only on CI name, class name, exception_since, user can specify the sort order.",
"required" : false,
"type" : "string",
"default" : "+class_name",
"enum" : [ "+name", "-name", "+class_name", "-class_name", "+exception_since", "-exception_since" ]
}, {
"name" : "name",
"in" : "query",
"description" : "Filtering string for CIName. Server will return entries having given string present in CI Name",
"required" : false,
"type" : "string"
}, {
"name" : "class_name",
"in" : "query",
"description" : "Filtering string for ClassName. Server will return entries having given string present in Class Name",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/completeness_exception_details"
}
}
}
}
},
"/cmdb/v1.0/health/details/integrity" : {
"get" : {
"tags" : [ "CMDB Health Exceptions Summary and Details." ],
"summary" : "Returns details for integrity exceptions.",
"description" : "You can get Integrity health exception details records by using health/details/completeness/{offset}/{limit}/{sort}/{filterCIName}/{filterClassName}",
"operationId" : "getIntegrityDetails",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "exception_type",
"in" : "query",
"description" : "Type of exceptions of which info need to be retrieved",
"required" : false,
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the exception details recto be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Number of exceptions details to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "The Exception Details can be sorted only on CI name, class name, exception_since, user can specify the sort order.",
"required" : false,
"type" : "string",
"default" : "+class_name",
"enum" : [ "+name", "-name", "+class_name", "-class_name", "+exception_since", "-exception_since" ]
}, {
"name" : "name",
"in" : "query",
"description" : "Filtering string for CIName. Server will return entries having given string present in CI Name",
"required" : false,
"type" : "string"
}, {
"name" : "class_name",
"in" : "query",
"description" : "Filtering string for ClassName. Server will return entries having given string present in Class Name",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/integrity_exception_details"
}
}
}
}
},
"/cmdb/v1.0/health/exceptions/summary/completeness" : {
"get" : {
"tags" : [ "CMDB Health Exceptions Summary and Details." ],
"summary" : "Get Completeness Health Exceptions Summary.",
"description" : "You can get the Completeness HealthException Summary by using health/exceptions/summary/completeness.",
"operationId" : "getCompletenessHealthExceptions",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/health_exception"
}
}
}
}
},
"/cmdb/v1.0/health/exceptions/summary/integrity" : {
"get" : {
"tags" : [ "CMDB Health Exceptions Summary and Details." ],
"summary" : "Get Integrity Health Exceptions Summary.",
"description" : "You can retrieve the Integrity Health Exceptions Summary by using the health/exceptions/summary/integrity/{type} Paremeter",
"operationId" : "getIntegrityHealthExceptions",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "exception_type",
"in" : "query",
"description" : "Type of Integrity exceptions of which info need to be retrieved",
"required" : false,
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/health_exceptions"
}
}
}
}
},
"/cmdb/v1.0/health/summary" : {
"get" : {
"tags" : [ "CMDB Health Exceptions Summary and Details." ],
"summary" : "Get Health Summary Information.",
"description" : "You can get health summary information by using health/summary.",
"operationId" : "getAgregatedHealthInfo",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/agregate_info"
}
}
}
}
},
"/cmdb/v1.0/icon/instances" : {
"get" : {
"tags" : [ "Api to retrive class icons." ],
"operationId" : "getListOfInstancesIcons",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/impacts/command/simulate" : {
"post" : {
"tags" : [ "Impacts Simulation Resources" ],
"summary" : "Simulate the impact",
"description" : "Simulate the impact for supplied CIs",
"operationId" : "simulateImpateForCis",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The instances list for which impact simulation need to be started.",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ImpactSimulationResult"
}
}
}
}
},
"/cmdb/v1.0/impacts/simulation/cis_graph/{simulation_id}" : {
"get" : {
"tags" : [ "Impacts Simulation Resources" ],
"summary" : "Get impact simulation results.",
"description" : "Get impacted CIs graph for a simulation id.",
"operationId" : "getImpactedCisBySimulation",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "simulation_id",
"in" : "path",
"description" : "Simulation Id for which impacted CIs graph need to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Graph Walk Result with UI Display Info"
}
}
}
}
},
"/cmdb/v1.0/impacts/simulation/status/{simulation_id}" : {
"get" : {
"tags" : [ "Impacts Simulation Resources" ],
"summary" : "Get the simulation status",
"description" : "Get the simulation status for supplied simulation id",
"operationId" : "getSimulationStatusForSimulationId",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "simulation_id",
"in" : "path",
"description" : "Simulation id",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "object"
}
}
}
}
},
"/cmdb/v1.0/indices/{namespace}/{className}" : {
"get" : {
"tags" : [ "CMDB Class Index Operations." ],
"summary" : "Returns indexes of the input class along with the indexes of all its parent classes.",
"description" : "Returns indexes of the input class along with the indexes of all its parent classes.",
"operationId" : "getClassIndexes",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name for which indices need to be returned.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ClassIndex"
}
}
}
},
"post" : {
"tags" : [ "CMDB Class Index Operations." ],
"summary" : "Creates an index for the given class with definition provided in the request body.",
"description" : "Creates an index for the given class with definition provided in the request body.",
"operationId" : "createClassIndex",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace name to which the class belongs.",
"required" : true,
"type" : "string",
"x-example" : "BMC.CORE"
}, {
"name" : "className",
"in" : "path",
"description" : "The Class name for which index needs to be created.",
"required" : true,
"type" : "string",
"x-example" : "BMC_BaseElement"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/instances" : {
"post" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Create Multiple Instances.",
"description" : "Create Multiple Instances supplied by Instance objects list in Body of the request.",
"operationId" : "createInstances",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The instances list containg the attributes with which instances need to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instances."
}
}
}
}
},
"delete" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Delete Multiple Instances.",
"description" : "Delete Multiple Instances supplied by Instance objects list in Body of the request.",
"operationId" : "deleteInstances",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "delete_option",
"in" : "query",
"description" : "Delete option which Instance need to be deleted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"in" : "body",
"name" : "body",
"description" : "The instances list containg the attributes with which instances need to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Update Multiple Instances.",
"description" : "Update Multiple Instances supplied by Instance objects list in Body of the request.",
"operationId" : "updateInstances",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The instances list containg the attributes with which instances need to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/instances/{datasetId}" : {
"post" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Creates Multiple instances for a given dataset.",
"description" : "You can create the require instances by using the /{datasetId} parameter with the instance information given in the request body.",
"operationId" : "createInstances",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which instances need to be created.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The instance list contains the attributes with which instances need to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Deletes multiple instances of a class for a given datasetId with given Instance Ids.",
"description" : "You can delete the required instances with /{datasetId} parameter.",
"operationId" : "deleteInstances",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which instances need to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "delete_option",
"in" : "query",
"description" : "Delete option that determines which instance needs to be deleted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"in" : "body",
"name" : "body",
"description" : "The instances list containing the attributes with which instances need to be deleted.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Updates multiple instances for a given dataset.",
"description" : "You can update the required instances belonging to a particular dataset using the /{datasetId} parameter by using the instance attributes given in the request body.",
"operationId" : "updateInstances",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which instances need to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The instances list contains the attributes with which instances need to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/instances/{datasetId}/{namespace}/{className}" : {
"get" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Gets multiple instances of a class for a given dataset.",
"description" : "You can retrieve the list of available instances by using the /{datasetId}/{namespace}/{className} parameters",
"operationId" : "getInstances",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which instances need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"description" : "Class Namespace for which instances need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Class Name for which instances need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "ids",
"in" : "query",
"description" : "InstanceIds for which instances need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "attributes",
"in" : "query",
"description" : "Attributes of instances using which instances need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "sort",
"in" : "query",
"description" : "Instance Attributes sort order in which the instances need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "qualification",
"in" : "query",
"description" : "Instance Qualification with which the instances need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the instances need to be retrieved.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum number of instances to be retrieved, used in conjunction with offset.",
"required" : false,
"type" : "string",
"default" : "500"
}, {
"name" : "dataset_mask",
"in" : "query",
"description" : "The dataset mask value to indicate if the instances should be pulled from Overlay or from the Base dataset.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"name" : "num_matches",
"in" : "query",
"description" : "Determines if we should return the number of matched instances.",
"required" : false,
"type" : "boolean",
"default" : false
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/instances"
}
}
}
}
},
"post" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"operationId" : "createInstanceWithAttachments",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"delete" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Deletes multiple instances of a class for a given dataset from instance list objects in the request body.",
"description" : "You can delete the required instances with the /{datasetId}/{namespace}/{className} and instances parameters in the request body.",
"operationId" : "deleteInstances",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "Class Name for which instances need to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"description" : "Class Namespace for which instances need to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Class Name for which instances need to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "ids",
"in" : "query",
"description" : "InstanceIds for which instances need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "delete_option",
"in" : "query",
"description" : "Delete option which determines Instance need to be deleted.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"in" : "body",
"name" : "body",
"description" : "The instances list contains the attributes with which instances need to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/instances"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"operationId" : "updateInstanceWithAttachments",
"consumes" : [ "multipart/form-data" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/instances/{datasetId}/{namespace}/{className}/{instanceId}" : {
"get" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Gets a single instance of a class for a given dataset for a given Instance Id.",
"description" : "You can retrieve the required instance by using the /{datasetId}/{namespace}/{className}/{instanceId} parameters.",
"operationId" : "getInstance",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"description" : "Class Namespace for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Class Name for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "instanceId",
"in" : "path",
"description" : "InstanceId for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "attributes",
"in" : "query",
"description" : "Attributes of instance using which an instance needs to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "dataset_mask",
"in" : "query",
"description" : "The dataset mask value to indicate if the instance should be pulled from Overlay or from the Base dataset.",
"required" : false,
"type" : "string",
"default" : "0"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/instances"
}
}
}
},
"delete" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Deletes single instance of a class for a given dataset for a given instance Id.",
"description" : "You can delete the required instance by using the /{datasetId}/{namespace}/{className}/{instanceId} parameters.",
"operationId" : "deleteInstance",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which an instance needs to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"description" : "Class Namespace for which an instance needs to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Class Name for which an instance needs to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "instanceId",
"in" : "path",
"description" : "InstanceId for which an instance needs to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "delete_option",
"in" : "query",
"description" : "Delete option to use while deleting an instance.",
"required" : false,
"type" : "string",
"default" : "0"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"summary" : "Updates a single instance of a class for a given dataset for a given instance Id.",
"description" : "You can update the required instance by using the /{datasetId}/{namespace}/{className}/{instanceId} parameters with attributes to be updated in the request body.",
"operationId" : "updateInstance",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "DatasetId for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"description" : "Class Namespace for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Class Name for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "instanceId",
"in" : "path",
"description" : "InstanceId for which an instance needs to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "dataset_mask",
"in" : "query",
"description" : "The dataset mask value to indicate if the instance should be pulled from Overlay or from Base dataset.",
"required" : false,
"type" : "string",
"default" : "0"
}, {
"in" : "body",
"name" : "body",
"description" : "The instances object containing the attributes using which the instance needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Instance"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/instances/{datasetId}/{namespace}/{className}/{instanceId}/attach/{attributeName}" : {
"get" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"operationId" : "getAttachement",
"produces" : [ "application/octet-stream" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "instanceId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "attributeName",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "dataset_mask",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "0"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/menus" : {
"get" : {
"tags" : [ "Menu(s) Read Operations." ],
"summary" : "Get AR Character Menus",
"description" : "Returns the list of names of AR character menus. ",
"operationId" : "getARMenus",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Filter string to filter by menu name.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of menus to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the menus to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/menus"
}
}
}
}
}
},
"/cmdb/v1.0/menus/list/all" : {
"get" : {
"tags" : [ "Menu(s) Read Operations." ],
"summary" : "Get AR Character Menus",
"description" : "Returns the list of names of AR character menus. ",
"operationId" : "getAllARMenus",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Filter string to filter by menu name.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/menus"
}
}
}
}
}
},
"/cmdb/v1.0/namespaces" : {
"get" : {
"tags" : [ "Returns CDM namespaces." ],
"summary" : "Returns namespaces",
"description" : "Returns namespaces matching to given search string or all if search string is not provided",
"operationId" : "getListOfNamespaces",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Specifies the namespace name with which search to be done",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the data source statistics to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Number of CI updates to to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/catalogmapping" : {
"get" : {
"tags" : [ "PC Catalog Mappings." ],
"summary" : "Get NE to Product Catalog Mappings ",
"description" : "Get NE to Product Catalog Mappings.",
"operationId" : "getListOfPCCatalogMappings",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset index at which the NE to Product Catalog Mappings should be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of NE to Product Catalog Mappings to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "class_id",
"in" : "query",
"description" : "Filter string for class Id on which atalog Mappings is to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "sort",
"in" : "query",
"description" : "The NE to Product Catalog Mappings will be sorted as per user specified the sortInfo details.",
"required" : false,
"type" : "string",
"enum" : [ "+mapping_id", "-mapping_id", "+class_id", "-class_id", "+mapped_product_name", "-mapped_product_name", "mapped_manufacturer", "-mapped_manufacturer", "+mapped_category", "-mapped_category", "+mapped_type", "-mapped_type", "+mapped_item", "-mapped_item" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/pc_alias_mappings"
}
}
}
},
"post" : {
"tags" : [ "PC Catalog Mappings." ],
"summary" : "Creates the NE to Product Catalog Alias Mapping.",
"description" : "Creates the Product Catalog Mapping for NE with details specified in the object provided in request body.",
"operationId" : "createPCAliasMapping",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The NE to Product Catalog Alias Mapping to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for PC alias mapping"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/catalogmapping/{mappingId}" : {
"get" : {
"tags" : [ "PC Catalog Mappings." ],
"summary" : "Get NE to Product Catalog Mapping for the mapping id ",
"description" : "Get NE to Product Catalog Mapping for the mapping id.",
"operationId" : "getPCCatalogMapping",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "mappingId",
"in" : "path",
"description" : "mappingId of the catalog mapping to be retrieved",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for PC alias mapping"
}
}
}
},
"delete" : {
"tags" : [ "PC Catalog Mappings." ],
"summary" : "Deletes the NE to Product Catalog Alias Mapping.",
"description" : "Deletes the NE to Product Catalog Alias Mapping with the mappingId provided as path param.",
"operationId" : "deletePCAliasMapping",
"parameters" : [ {
"name" : "mappingId",
"in" : "path",
"description" : "The NE to Product Catalog Alias Mapping to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "PC Catalog Mappings." ],
"summary" : "Updates the NE to PC catalog mappings.",
"description" : "Updates the NE to PC catalog mappings provided in request body.",
"operationId" : "updateNEPCAliasMapping",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "mappingId",
"in" : "path",
"description" : "The NE to Product Catalog Alias Mapping to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "NE to PC catalog mapping object which needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for PC alias mapping"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/class" : {
"get" : {
"tags" : [ "NE Class Configurations." ],
"summary" : "Get multiple NE Class Configurations ",
"description" : "Get multiple NE Class Configurations with pagination and sorting support for class.",
"operationId" : "getNEClassConfigurations",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset index at which the NE Class Configurations should be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of NE Class Configurations to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "The NE Class Configurations will always be sorted only on class name, user can specify the sort order.",
"required" : false,
"type" : "string",
"default" : "+class_name_key",
"enum" : [ "+class_name_key", "-class_name_key" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ne_class_configs"
}
}
}
},
"post" : {
"tags" : [ "NE Class Configurations." ],
"summary" : "Creates the NE Class Configuration.",
"description" : "Creates the NE Class Configuration with configuration object provided in request body.",
"operationId" : "createNeClassConfig",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The NE Class Configuration to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for NE Class Configuration"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/class/{classConfigId}" : {
"delete" : {
"tags" : [ "NE Class Configurations." ],
"summary" : "Deletes the NE class configuration.",
"description" : "Deletes the NE class configuration with the classConfigId provided as path param.",
"operationId" : "deleteNEClassConfig",
"parameters" : [ {
"name" : "classConfigId",
"in" : "path",
"description" : "The NE class configuration to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/dataset" : {
"get" : {
"tags" : [ "NE Dataset Configuration for a given job." ],
"summary" : "Get multiple NE Dataset Configurations ",
"description" : "Get multiple NE Dataset Configurations with pagination and sorting support for dataset.",
"operationId" : "getListOfNEDatasetConfigurations",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset index at which the NE Dataset Configurations should be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of NE Dataset Configurations to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "The NE Dataset Configurations will always be sorted only on dataset_id, user can specify the sort order.",
"required" : false,
"type" : "string",
"default" : "+dataset_id",
"enum" : [ "+dataset_id", "-dataset_id" ]
}, {
"name" : "dataset_id",
"in" : "query",
"description" : "Filtering string. Server supports filtering based on Dataset Id. Server will return entries having given string present in DatasetId",
"required" : false,
"type" : "string"
}, {
"name" : "mode",
"in" : "query",
"description" : "Normalization mode against which the dataset configurations are to be retrieved.",
"required" : false,
"type" : "string",
"enum" : [ "INLINE", "CONTINUOUS", "OFF" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/dataset_configs"
}
}
}
},
"patch" : {
"tags" : [ "NE Dataset Configuration for a given job." ],
"summary" : "Updates multiple NE Dataset Configurations.",
"description" : "Updates multiple NE Dataset Configurations for the datset configuration objects passed in the Body of the request.",
"operationId" : "updateNEDatasetConfigurations",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "NE Dataset Configuration objects which need to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/dataset_configs"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/dataset/{datasetId}" : {
"get" : {
"tags" : [ "NE Dataset Configuration for a given job." ],
"summary" : "Get Dataset Configuration Info",
"description" : "You can retrieve the dataset configuration information by using the ne/configurations/dataset/{datasetId} parameter.",
"operationId" : "getNEDatasetConfiguration",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "id for which the Dataset Configuration need to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE Dataset Configuration"
}
}
}
},
"patch" : {
"tags" : [ "NE Dataset Configuration for a given job." ],
"summary" : "Updates the NE Dataset Configuration.",
"description" : "Updates the NE Dataset Configuration provided in request body.",
"operationId" : "updateNEDatasetConfiguration",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "NE Dataset Configuration Id of job which needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "NE Dataset Configuration which needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for NE Dataset Configuration"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/configurations/system" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Normalization System Configurations.",
"description" : "Get Normalization System Configurations.",
"operationId" : "getListOfSystemConfigurations",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Centralized Configuration Settings"
}
}
}
},
"patch" : {
"tags" : [ "NE Utilities." ],
"summary" : "Updates the System Configurations.",
"description" : "Updates the System Configurations provided in request body.",
"operationId" : "updateSystemConfigurations",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "System Configurations to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Centralized Configuration Settings"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/jobs" : {
"get" : {
"tags" : [ "NE Jobs." ],
"summary" : "Get All Jobs for Normalization.",
"description" : "You can retrieve the required jobs information by using the /{ne}/{jobs} parameters.",
"operationId" : "getAllJobs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Jobs need to be retrieved. If value for this is not provided, All Jobs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Jobs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Jobs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Jobs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+name", "-name" ]
}, {
"name" : "name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE Job."
}
}
}
},
"post" : {
"tags" : [ "NE Jobs." ],
"summary" : "Creates the job.",
"description" : "Creates the job with definition provided in request body.",
"operationId" : "createJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ne job to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NEJob"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/jobs/runinfo/failedcis/{jobRunId}" : {
"get" : {
"tags" : [ "NE Failed CI Reporting." ],
"summary" : "Get failed CI details for given job run.",
"description" : "You can retrieve the required failed CIs for given job run information by using the /{ne}/{jobsruninfo}/{jobrunfailecis}/{jobRunId} parameters.",
"operationId" : "getFailedCIs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobRunId",
"in" : "path",
"description" : "Job Run Instance for which the Failed CIs need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "ci_type",
"in" : "query",
"description" : "Type of CI, Relationship or CI for which to fetch failed instances. If the CI Type is not provided, both CI and Relationships types would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "CI", "RELATIONSHIP" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Run Failed CIs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Run Failed CIs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the CI Details need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+ci_name", "-ci_name", "+dataset_id", "-dataset_id", "+class_name", "-class_name" ]
}, {
"name" : "ci_name",
"in" : "query",
"description" : "CI name for which the Failed CIs need to be retrieved. If value for this is not provided, All Failed CIs for given Job Run would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs ids to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs ids to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Failed CIs for given job run."
}
}
}
}
},
"/cmdb/v1.0/ne/jobs/runinfo/history/{jobDefinitionId}" : {
"get" : {
"tags" : [ "NE Job Runs History." ],
"summary" : "Get Job Runs History Info for NE.",
"description" : "You can retrieve the required job runs history information by using the /{ne}/{jobs}/{runinfo}/{history}/{jobDefinitionId} parameters.",
"operationId" : "getJobRunsHistory",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Job Instance Id for which the Job Runs History need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs History need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+run_start_Time", "-run_start_Time", "+run_end_Time", "-run_end_Time", "+job_status", "-job_status" ]
}, {
"name" : "job_run_status",
"in" : "query",
"description" : "Job run status - All job runs with this status will be retrieved",
"required" : false,
"type" : "string",
"enum" : [ "STARTED", "ABORTED", "STOPPED", "COMPLETED" ]
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE Jobs Run History.."
}
}
}
}
},
"/cmdb/v1.0/ne/jobs/runinfo/jobswithnoruns" : {
"get" : {
"tags" : [ "NE Jobs with no runs Information." ],
"summary" : "Get Jobs with no runs for NE.",
"description" : "You can retrieve the required job runs information by using the /{ne}/{jobs}/{runinfo}/{jobswithnoruns} parameters.",
"operationId" : "getJobRunsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+name", "-name" ]
}, {
"name" : "name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE Job."
}
}
}
}
},
"/cmdb/v1.0/ne/jobs/runinfo/lastruninfo" : {
"get" : {
"tags" : [ "NE Job Runs Information." ],
"summary" : "Get Last Job Runs Info for NE.",
"description" : "You can retrieve the required job runs information by using the /{ne}/{jobs}/{runinfo}/{lastjobsruninfo} parameters.",
"operationId" : "getJobRunsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Semi-colon separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name", "+job_status", "-job_status", "+successful_cis", "-successful_cis", "+successful_relationships", "-successful_relationships", "+failed_cis", "-failed_cis", "+failed_relationships", "-failed_relationships" ]
}, {
"name" : "job_definition_id",
"in" : "query",
"description" : "Job Definition Instance Id for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE Jobs Run Info."
}
}
}
}
},
"/cmdb/v1.0/ne/jobs/runinfo/summary" : {
"get" : {
"tags" : [ "NE Job Runs Information." ],
"summary" : "Returns Job summary for NE.",
"description" : "You can retrieve the All Jobs, Not Run Jobs, Failed CIs and Failed Relationships summary by using the /{ne}/{jobs}/{runinfo}/{summary} parameters.",
"operationId" : "getJobSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Specifies the name of the datasource Id for which statistics to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the all jobs, not run job, failed CIs and failed relationships to be retrived.",
"required" : false,
"type" : "string",
"default" : "TODAY"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE last job run summary"
}
}
}
}
},
"/cmdb/v1.0/ne/jobs/{jobDefinitionId}" : {
"get" : {
"tags" : [ "NE Jobs." ],
"summary" : "Get Job by Job Instance Id.",
"description" : "Get Job by Job Instance Id.",
"operationId" : "getJobById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Job Instance Id of job which needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/NEJob"
}
}
}
},
"delete" : {
"tags" : [ "NE Jobs." ],
"summary" : "Deletes the job.",
"description" : "Deletes the job with the job id provided as path param.",
"operationId" : "deleteJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "The ne job to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "NE Jobs." ],
"summary" : "Updates the job.",
"description" : "Updates the job with definition provided in request body.",
"operationId" : "updateJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Job Instance Id of job which needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The ne job to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/NEJob"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/utilities/availableattributes/{namespace}/{className}" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Available Attributes List for a given Class & Namespace.",
"description" : "Get Available Attribute List for a given Class & Namespace.",
"operationId" : "getAvailableAttributes",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace for which the Id Rule Groups need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname for which to fetch Id Rule Groups.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/utilities/manufacturer" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Manufacturer List.",
"description" : "Get Manufacturer List.",
"operationId" : "getAllManufacturers",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/utilities/marketversion" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Market Version List.",
"description" : "Get Market Version List.",
"operationId" : "getMarketVersions",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "product_name",
"in" : "query",
"description" : "Product Name whose Market Version need to be fetched.",
"required" : false,
"type" : "string"
}, {
"name" : "manufacturer_name",
"in" : "query",
"description" : "Manufacturer Name whose Market Version need to be fetched.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/utilities/product" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Product List.",
"description" : "Get Product List.",
"operationId" : "getAllProducts",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "product_name",
"in" : "query",
"description" : "Product Name whose Product List need to be fetched.",
"required" : false,
"type" : "string"
}, {
"name" : "manufacturer_name",
"in" : "query",
"description" : "Manufacturer Name whose Product List need to be fetched.",
"required" : false,
"type" : "string"
}, {
"name" : "version",
"in" : "query",
"description" : "Version whose Product List need to be fetched.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/utilities/productcategory" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Product Category List.",
"description" : "Get Product Category List.",
"operationId" : "getAllProductCategories",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/utilities/productitem" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Product Item List.",
"description" : "Get Product Item List.",
"operationId" : "getAllProductItems",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/utilities/producttype" : {
"get" : {
"tags" : [ "NE Utilities." ],
"summary" : "Get Product Type List.",
"description" : "Get Product Type List.",
"operationId" : "getAllProductTypes",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"type" : "object"
}
}
}
}
}
},
"/cmdb/v1.0/ne/{feature}/rules" : {
"get" : {
"tags" : [ "CRUD operations on NE Rules." ],
"summary" : "Get All Rules.",
"description" : "Get All Rules based on feature id.",
"operationId" : "getAllRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "feature",
"in" : "path",
"description" : "Feature for which all rules need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "sort",
"in" : "query",
"description" : "Sort order in which the rules need to be retrieved.",
"required" : false,
"type" : "string",
"enum" : [ "+is_enabled", "-is_enabled", "+name", "-name", "+manufacturer_name", "-manufacturer_name", "+product_name", "-product_name", "+class_name_key", "-class_name_key", "+group_name", "-group_name", "+precedence", "-precedence", "+suite_name", "-suite_name", "+suite_manufacturer", "-suite_manufacturer", "+suite_rule.precedence", "-suite_rule.precedence", "+suite_market_version", "-suite_market_version" ]
}, {
"name" : "name",
"in" : "query",
"description" : "RuleName qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "manufacturer_name",
"in" : "query",
"description" : "ManufacturerName qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "product_name",
"in" : "query",
"description" : "ProductName qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "class_name_key",
"in" : "query",
"description" : "ClassNameKey qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "group_name",
"in" : "query",
"description" : "GroupName qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "suite_name",
"in" : "query",
"description" : "SuiteName qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "suite_manufacturer",
"in" : "query",
"description" : "Manufacturer qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "suite_market_version",
"in" : "query",
"description" : "MarketVersion qualification with which the rules need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the rules need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Rules to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for NE NERule"
}
}
}
}
},
"post" : {
"tags" : [ "CRUD operations on NE Rules." ],
"summary" : "Creates the rule.",
"description" : "Creates the rule with definition provided in request body.",
"operationId" : "createRule",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ne rule to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for NE NERule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ne/{feature}/rules/{ruleId}" : {
"get" : {
"tags" : [ "CRUD operations on NE Rules." ],
"summary" : "Get Rule by Id.",
"description" : "Get Rule based on feature id and rule id.",
"operationId" : "getRuleById",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "feature",
"in" : "path",
"description" : "Feature for which rule need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "ruleId",
"in" : "path",
"description" : "RuleId for which rule need to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for NE NERule"
}
}
}
},
"delete" : {
"tags" : [ "CRUD operations on NE Rules." ],
"summary" : "Delete NERule.",
"description" : "Delete NERule based on rule id and feature id.",
"operationId" : "deleteRule",
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "RuleId for which an rule need to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "feature",
"in" : "path",
"description" : "Feature for which an rule need to be deleted.",
"required" : true,
"type" : "string"
}, {
"name" : "delete_option",
"in" : "query",
"description" : "Delete Option to delete suite.",
"required" : false,
"type" : "string",
"default" : "SUITE"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "CRUD operations on NE Rules." ],
"summary" : "Updates the rule.",
"description" : "Updates the rule with definition provided in request body.",
"operationId" : "updateRule",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The ne rule to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for NE NERule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/permissions/groups" : {
"get" : {
"tags" : [ "Permission(s) Create Read Operations." ],
"summary" : "Get dataset permissions for groups.",
"description" : "Returns the list of groups permissions applicable for datasets.",
"operationId" : "getDatasetPermissionGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Filter string to filter by name for group permissions to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of group permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the group permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/permissions/names" : {
"get" : {
"tags" : [ "Permission(s) Create Read Operations." ],
"summary" : "Get dataset permission names.",
"description" : "Returns the list of permissions for given permission ids.",
"operationId" : "getDatasetPermissionNames",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "permission_ids",
"in" : "query",
"description" : "Comma separated list of dataset permissions Ids.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/permissions/roles" : {
"get" : {
"tags" : [ "Permission(s) Create Read Operations." ],
"summary" : "Get permissions for roles.",
"description" : "Returns the list of role permissions configured for CMDB application.",
"operationId" : "getDatasetPermissionRoles",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Filter string to filter by name for role permissions to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of role permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the role permissions to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/productionupdates/details" : {
"get" : {
"tags" : [ "Returns information on CI changes in Production Dataset" ],
"summary" : "Details of Production CI Updates",
"description" : "For given date range and other filtering options, it returns details of CIs updated in Production dataset BMC.ASSET.",
"operationId" : "getCIUpdatesDetails",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "from_date",
"in" : "query",
"description" : "From Date for getting production CI updates summary.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "To Date for getting production CI updates summary.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "ci_name",
"in" : "query",
"description" : "Specifies the CI name with which search to be done",
"required" : false,
"type" : "string"
}, {
"name" : "sort",
"in" : "query",
"description" : "Sort information, separated by comma when sorting is to be done on multiple columns. For ascending order, preceed the column name with \"+\" or use just the column name. For descending order, preceed the column name with \"-\".",
"required" : false,
"type" : "string",
"x-example" : "name",
"enum" : [ "+ci_name", "-ci_name", "+update_date", "-update_date" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the data source statistics to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Number of CI updates to to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "ci_type",
"in" : "query",
"description" : "Specifies the type of instances to be retrived back.",
"required" : false,
"type" : "string",
"default" : "CLASS",
"enum" : [ "[CLASS", "RELATIONSHIP]" ]
}, {
"name" : "ci_operation",
"in" : "query",
"description" : "Specifies the CI operations. When not specified, it will return all. If not specified, it will being CIs for all types of operations.",
"required" : false,
"type" : "string",
"enum" : [ "[CREATED", "EDITED", "MARK_AS_DELETED]" ]
}, {
"name" : "num_matches",
"in" : "query",
"description" : "Specifies whether to return back number of matched instances.",
"required" : false,
"type" : "boolean",
"default" : false
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/ci_update_details"
}
}
}
}
},
"/cmdb/v1.0/productionupdates/summary" : {
"get" : {
"tags" : [ "Returns information on CI changes in Production Dataset" ],
"summary" : "Summary of Production CI Updates",
"description" : "For given date range, it returns summary of Production CI updates like how may CIs are created/updated for Class or Relatiomnship.",
"operationId" : "getCIUpdatesSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "from_date",
"in" : "query",
"description" : "From Date for getting production CI updates summary.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "To Date for getting production CI updates summary.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for CIUpdates Summary"
}
}
}
}
},
"/cmdb/v1.0/querybypath" : {
"get" : {
"tags" : [ "Instanc API for query By Path." ],
"summary" : "Enables you to retrieve a list of instances for the specified qualifications.",
"description" : "You can retrieve the required instance by using the /{querybypath} parameters.",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "qualification",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain for Query By Path response"
}
}
}
},
"post" : {
"tags" : [ "Instanc API for query By Path." ],
"operationId" : "post",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"responses" : {
"default" : {
"description" : "successful operation"
}
},
"deprecated" : true
}
},
"/cmdb/v1.0/re/configurations/id/rulegroups/custom" : {
"post" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Create Id Rule Group.",
"description" : "You can create the required Id Rule Group by using the /{re}/{configurations}/{id}/{rulegroups}/{custom} parameters.",
"operationId" : "createCustomIdRuleGroup",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Rule Group object containing the attributes using which the Rule Group needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Identification Group"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rulegroups/custom/{groupId}" : {
"delete" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Delete Id Rule Group for given Group Id.",
"description" : "You can delete the required Id Rule Group by using the /{re}/{configurations}/{id}/{rulegroups}/{custom}/{groupId} parameters.",
"operationId" : "deleteCustomIdGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"description" : "Rule Group Id for which the Rule Group need to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Update Id Rule Group for given Rule Group Id.",
"description" : "You can update the required Id Rule Group by using the /{re}/{configurations}/{id}/{rulegroups}/{custom}/{groupId} parameters.",
"operationId" : "updateCustomIdRuleGroup",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"description" : "Rule Id for which the Id need to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The Rule Group object containing the attributes using which the Rule Group needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Identification Group"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rulegroups/custom/{namespace}/{className}" : {
"get" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Get Id Rule Groups for given class.",
"description" : "You can retrieve the required Id Groups with Rules by using the /{re}/{configurations}/{id}/{rulegroups}/{custom}/{namespace}/{className} parameters.",
"operationId" : "getCustomIdGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace for which the Id Rule Groups need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname for which to fetch Id Rule Groups.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Id Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Id Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Identification Group Info."
}
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rulegroups/standard/{namespace}/{className}" : {
"get" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Get Standard Id Rule Groups for given class.",
"description" : "You can retrieve the required Standard Id Groups with Rules by using the /{re}/{configurations}/{id}/{rulegroups}/{standard}/{namespace}/{className} parameters.",
"operationId" : "getStandardIdGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace for which the Id Rule Groups need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname for which to fetch Id Rule Groups.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Id Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Id Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Identification Group Info."
}
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rules/custom" : {
"get" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Get Id Rules.",
"description" : "You can retrieve the required Id Rules by using the /{re}/{configurations}/{id}/{rules}/{custom}/ } parameters.",
"operationId" : "getCustomIdRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupId",
"in" : "query",
"description" : "Group Id for which the Id Rule Groups need to be retrieved",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Id Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Id Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Identification Rule Info."
}
}
}
},
"post" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Create Id Rule.",
"description" : "You can create the required Id Rule by using the /{re}/{configurations}/{id}/{rules}/{custom} parameters.",
"operationId" : "createCustomIdRule",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Rule object containing the attributes using which the Rule needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Identification Rule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rules/custom/{ruleId}" : {
"delete" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Delete Id Rule for given Rule Id.",
"description" : "You can delete the required Id Rule by using the /{re}/{configurations}/{id}/{rules}/{custom}/{ruleId} parameters.",
"operationId" : "deleteCustomIdRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "Rule Id for which the Id need to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Update Id Rule for given Rule Id.",
"description" : "You can update the required Id Rule by using the /{re}/{configurations}/{id}/{rules}/{ruleId} parameters.",
"operationId" : "updateCustomIdRule",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "Rule Id for which the Id need to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The Rule object containing the attributes using which the Rule needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Identification Rule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rules/standard" : {
"post" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Add Standard Id Rule.",
"description" : "You can Add the Standard Id Rule by using the /{re}/{configurations}/{id}/{rules}/{standard}/{namespace}/{className} } parameters.",
"operationId" : "createStandardIdentificationRule",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "standard Id Rule object to be Added",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StdIdentificationRule"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rules/standard/{namespace}/{className}/{priority}/attributes" : {
"get" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Get Standard Id Rule with attribute for given sequence number.",
"description" : "You can retrieve the required Standard Id Rules by using the /{re}/{configurations}/{id}/{rules}/{standard}/{namespace}/{className}/{priority}/{attributes} } parameters.",
"operationId" : "getStandardIdentificationRulesWithAttributes",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace for which the Id Rule need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname for which to fetch Id Rule.",
"required" : true,
"type" : "string"
}, {
"name" : "priority",
"in" : "path",
"description" : "Sequence Number for which the Id Rule Groups need to be retrieved",
"required" : true,
"type" : "integer",
"default" : 1,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/StdIdentificationRuleList"
}
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rules/standard/{namespace}/{className}/{sequenceNumber}" : {
"get" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Get Standard Id Rule for given sequence number.",
"description" : "You can retrieve the required Standard Id Rules by using the /{re}/{configurations}/{id}/{rules}/{standard}/{namespace}/{className}/{sequenceNumber} } parameters.",
"operationId" : "getStandardIdentificationRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "namespace",
"in" : "path",
"description" : "Namespace for which the Id Rule need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"description" : "Classname for which to fetch Id Rule.",
"required" : true,
"type" : "string"
}, {
"name" : "sequenceNumber",
"in" : "path",
"description" : "Sequence Number for which the Id Rule Groups need to be retrieved",
"required" : true,
"type" : "integer",
"default" : 1,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Identification Rule Info."
}
}
}
}
},
"/cmdb/v1.0/re/configurations/id/rules/standard/{ruleId}" : {
"delete" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Delete Standard Id Rule.",
"description" : "You can Delete the Standard Id Rule by using the /{re}/{configurations}/{id}/{rules}/{standard}//{ruleId} } parameters.",
"operationId" : "deleteStandardIdentificationRule",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "Rule Id to Delete standard Id Rule.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
},
"patch" : {
"tags" : [ "RE Identification Rules Management." ],
"summary" : "Add Standard Id Rule.",
"description" : "You can Update the Standard Id Rule by using the /{re}/{configurations}/{id}/{rules}/{standard}/{namespace}/{className}/{ruleId} } parameters.",
"operationId" : "updateStandardIdentificationRule",
"consumes" : [ "application/json" ],
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "Rule Id to update Id Rule.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Standard Id Rule object to be update",
"required" : true,
"schema" : {
"$ref" : "#/definitions/StdIdentificationRule"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/associationset" : {
"get" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Get Merge Association Sets.",
"description" : "You can retrieve the list of Merge Association Sets by using the /{re}/{configurations}/{merge}/{associationset} parameters.",
"operationId" : "getListOfMergeAssociationSets",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "name",
"in" : "query",
"description" : "Name with which the Merge Association Sets need to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Merge Association Sets need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Merge Association Sets to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Merge Association Set Info."
}
}
}
},
"post" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Create Merge Association Set.",
"description" : "You can create the required Merge Association Set by using the /{re}/{configurations}/{merge}/{associationset} parameters.",
"operationId" : "createMergeAssociationSet",
"produces" : [ "application/json" ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/associationset/datasetgroupassociation" : {
"get" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Get Merge Dataset and Group Details.",
"description" : "You can retrieve the required Merge Dataset Group Associations and Merge Group Details for a given Merge Association Set Id by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation} parameters.",
"operationId" : "getMergeDatasetGroupInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "merge_association_set_id",
"in" : "query",
"description" : "Merge Association Set Id for which the Merge Dataset Group Associations and Merge Group Details need to be retrieved.",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Merge Dataset Group Associations and Merge Group Details need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Merge Dataset Group Associations and Merge Group Details to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/MergeDatasetGroupInfoList"
}
}
}
},
"post" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Create Merge Dataset Group Association and Merge Group Details.",
"description" : "You can create the required Merge Dataset Group Association and Merge Group Details by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation} parameters.",
"operationId" : "createMergeDatasetGroupInfo",
"produces" : [ "application/json" ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/associationset/datasetgroupassociation/{mergeDatasetAssociationId}" : {
"delete" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Delete Merge Dataset Group Associations and Merge Group Details for given Merge Association Id.",
"description" : "You can delete the required Merge Dataset Group Associations and Merge Group Details by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation}/{mergeDatasetAssociationId} parameters.",
"operationId" : "deleteMergeDatasetGroupInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "mergeDatasetAssociationId",
"in" : "path",
"description" : "Merge Dataset Group Association Id for which the Merge Dataset Group Associations and Merge Group Details need to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Update Merge Dataset Group Association and Merge Group Details for given Merge Dataset Association Id.",
"description" : "You can update the required Merge Dataset Group Association and Merge Group Details by using the /{re}/{configurations}/{merge}/{associationset}/{datasetgroupassociation}/{mergeDatasetAssociationId} parameters.",
"operationId" : "updateMergeDatasetGroupInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "mergeDatasetAssociationId",
"in" : "path",
"description" : "Merge Dataset Association Id for which the Merge Dataset Group Association and Merge Group Details need to be updated.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/associationset/{instanceId}" : {
"get" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Get Merge Association Set.",
"description" : "You can retrieve the list of Merge Association Sets by using the /{re}/{configurations}/{merge}/{associationset}/{instanceId} parameters.",
"operationId" : "getMergeAssociationSet",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "instanceId",
"in" : "path",
"description" : "InstanceId for which merge association set need to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Merge Association Set"
}
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/associationset/{mergeAssociationSetId}" : {
"delete" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Delete Merge Association Set for given Merge Association Set Id.",
"description" : "You can delete the required Merge Association Set by using the /{re}/{configurations}/{merge}/{associationset}/{mergeAssociationSetId} parameters.",
"operationId" : "deleteMergeAssociationSet",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "mergeAssociationSetId",
"in" : "path",
"description" : "Merge Association Set Id for which the Merge Association Set need to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Update Merge Association Set for given Merge Association Set Id.",
"description" : "You can update the required Merge Dataset Group Association Set by using the /{re}/{configurations}/{merge}/{associationset}/{mergeAssociationSetId} parameters.",
"operationId" : "updateMergeAssociationSet",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "mergeAssociationSetId",
"in" : "path",
"description" : "Merge Dataset Group Association Set Id for which the Merge Dataset Group Association Set need to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The MergeAssociationSet object containing the attributes using which the Merge Dataset Group Association Set needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Merge Association Set"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/rules/standard" : {
"get" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Get Standard Merge Rules.",
"description" : "You can retrieve the required Standard Merge Rules by using the /{re}/{configurations}/{merge}/{rules}/{standard} parameters.",
"operationId" : "getStandardMergeRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Standard Merge Rules need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Standard Merge Rules to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "dataset_id",
"in" : "query",
"description" : "Dataset ID by which standard merge rules filtered",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Std Merge Rules List"
}
}
}
}
},
"/cmdb/v1.0/re/configurations/merge/rules/standard/{datasetId}" : {
"patch" : {
"tags" : [ "RE Merge Rules Management." ],
"summary" : "Update Std Merge Dataset Group Association and Std Merge Rule Details for given Merge Dataset Id.",
"description" : "You can update the required Std Merge Dataset Group Association and Std Merge Group Details by using the /{re}/{configurations}/{merge}/{rules}/{standard}/{datasetId} parameters.",
"operationId" : "updateStandardMergeRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"description" : "Merge Dataset Association Id for which the Merge Dataset Group Association and Std Merge Group Details need to be updated.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/qualification/rulegroups" : {
"get" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Get Qualification Rule Groups.",
"description" : "You can retrieve the required Qualification Groups by using the /{re}/{configurations}/{qualification}/{rulegroups} parameters.",
"operationId" : "getQualificationGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Qualification Rule Groups need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Qualification Rule Groups to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Identification Group Info."
}
}
}
},
"post" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Create Qualification Rule Group.",
"description" : "You can create the required Qualification Rule Group by using the /{re}/{configurations}/{qualification}/{rulegroups} parameters.",
"operationId" : "createQualificationRuleGroup",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Rule Group object containing the attributes using which the Rule Group needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Qualification Group"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/qualification/rulegroups/{groupId}" : {
"delete" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Delete Qualification Rule Group for given Group Id.",
"description" : "You can delete the required Qualification Rule Group by using the /{re}/{configurations}/{qualification}/{rulegroups}/{groupId} parameters.",
"operationId" : "deleteQualificationGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"description" : "Rule Group Qualification for which the Rule Group need to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Update Qualification Rule Group for given Rule Group Id.",
"description" : "You can update the required Qualification Rule Group by using the /{re}/{configurations}/{qualification}/{rulegroups}/{groupId} parameters.",
"operationId" : "updateQualificationRuleGroup",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"description" : "Rule Id for which the Qualification Rule Group need to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The Rule Group object containing the attributes using which the Rule Group needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Qualification Group"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/qualification/rules" : {
"post" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Create Qualification Rule.",
"description" : "You can create the required Qualification Rule by using the /{re}/{configurations}/{qualification}/{rules}/ parameters.",
"operationId" : "createQualificationRule",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "The Rule object containing the attributes using which the Rule needs to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Qualification Rule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/qualification/rules/{groupId}" : {
"get" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Get Qualification Rules.",
"description" : "You can retrieve the required Qualification Rules by using the /{re}/{configurations}/{qualification}/{rules}/{groupId} } parameters.",
"operationId" : "getQualificationRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "groupId",
"in" : "path",
"description" : "Group Id for which the Qualification Rules need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Qualification Rules need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Qualification Rules to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/configurations/qualification/rules/{ruleId}" : {
"delete" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Delete Qualification Rule for given Rule Id.",
"description" : "You can delete the required Qualification Rule by using the /{re}/{configurations}/{qualification}/{rules}/{ruleId} parameters.",
"operationId" : "deleteQualificationRules",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "Rule Id for which the Qualification need to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "RE Qualification Rules Management." ],
"summary" : "Update Qualification Rule for given Rule Id.",
"description" : "You can update the required Qualification Rule by using the /{re}/{configurations}/{qualification}/{rules}/{ruleId} parameters.",
"operationId" : "updateQualificationRule",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ruleId",
"in" : "path",
"description" : "Rule Id for which the Qualification need to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "The Rule object containing the attributes using which the Rule needs to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Qualification Rule"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/jobs" : {
"get" : {
"tags" : [ "Reconcialiation Job Create Read Update Delete Operations." ],
"summary" : "Get All Jobs for RE.",
"description" : "You can retrieve the required jobs information by using the /{re}/{jobs} parameters.",
"operationId" : "getAllJobs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Jobs need to be retrieved. If value for this is not provided, All Jobs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Jobs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Jobs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Jobs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name" ]
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "activity_type",
"in" : "query",
"description" : "Activity for which the Job Runs need to be retrieved. If value for this is not provided, last Job Runs for all activities would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "MERGE", "COMPARE", "IDENTIFY", "RENAME", "EXECUTE", "COPY", "PURGE", "DELETE" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Job."
}
}
}
},
"post" : {
"tags" : [ "Reconcialiation Job Create Read Update Delete Operations." ],
"summary" : "Creates Reconcilaition Job.",
"description" : "Creates Reconcilaition Job with definition provided in request body.",
"operationId" : "createJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Reconciliation Job Object that is to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/failedcis/{jobRunId}" : {
"get" : {
"tags" : [ "RE Failed CI Reporting." ],
"summary" : "Get failed CI details for given job run.",
"description" : "You can retrieve the required failed CIs for given job run information by using the /{re}/{jobsruninfo}/{jobrunfailecis}/{jobRunId} parameters.",
"operationId" : "getFailedCIs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobRunId",
"in" : "path",
"description" : "Job Run Instance for which the Failed CIs need to be retrieved",
"required" : true,
"type" : "string"
}, {
"name" : "ci_type",
"in" : "query",
"description" : "Type of CI, Relationship or CI for which to fetch failed instances. If the CI Type is not provided, both CI and Relationships types would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "CI", "RELATIONSHIP" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Run Failed CIs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Run Failed CIs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the CI Details need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+ci_name", "-ci_name", "+dataset_id", "-dataset_id", "+class_name", "-class_name" ]
}, {
"name" : "ci_name",
"in" : "query",
"description" : "CI name for which the Failed CIs need to be retrieved. If value for this is not provided, All Failed CIs for given Job Run would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs History to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Failed CIs for given job run."
}
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/history/{jobDefinitionId}" : {
"get" : {
"tags" : [ "Reconcialiation Job Events Read operation for a given Job." ],
"summary" : "Gets Reconciliation Job Event details of all job runs for a given Job Definition Instance Id.",
"description" : "You can retrieve all the Job Events by using the /{re}/{jobevents}/history/{jobDefinitionId} parameter.",
"operationId" : "getJobRunsHistory",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the job run details need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+run_start_time", "-run_start_time", "+run_end_time", "-run_end_time", "+job_run_status", "-job_run_status" ]
}, {
"name" : "job_run_status",
"in" : "query",
"description" : "Job run status - All job runs with this status will be retrieved",
"required" : false,
"type" : "string",
"enum" : [ "STARTED", "SUCCESS", "FAILED", "CANCELLED", "ABORTED", "QUEUED", "PAUSED", "SGPAUSED" ]
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the job runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Number of job runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Job Runs with Start Date after this would be retrieved",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "Job Runs with End Date before this would be retrieved",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job Events"
}
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/jobswithnoruns" : {
"get" : {
"tags" : [ "RE Jobs with no runs Information." ],
"summary" : "Get Jobs with no runs for RE.",
"description" : "You can retrieve the required job runs information by using the /{re}/{jobs}/{runinfo}/{jobswithnoruns} parameters.",
"operationId" : "getJobRunsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name" ]
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "activity_type",
"in" : "query",
"description" : "Activity Type for which the Job Runs need to be retrieved. If value for this is not provided, jobs which are not run would be returned for all activities.",
"required" : false,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Job."
}
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/lastruninfo" : {
"get" : {
"tags" : [ "RE Job Runs Information." ],
"summary" : "Get Last Job Runs Info for RE.",
"description" : "You can retrieve the required job runs information by using the /{re}/{jobs}/{runinfo}/{lastruninfo} parameters.",
"operationId" : "getJobRunsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Job Runs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Job Runs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name", "+job_status", "-job_status", "+successful_cis", "-successful_cis", "+successful_relationships", "-successful_relationships", "+failed_cis", "-failed_cis", "+failed_relationships", "-failed_relationships" ]
}, {
"name" : "job_definition_id",
"in" : "query",
"description" : "Job Definition Instance Id for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "activity_type",
"in" : "query",
"description" : "Activity for which the Job Runs need to be retrieved. If value for this is not provided, last Job Runs for all activities would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "MERGE", "COMPARE", "IDENTIFY", "RENAME", "EXECUTE", "COPY", "PURGE", "DELETE" ]
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Jobs Run Info."
}
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/lastruninfo/summary" : {
"get" : {
"tags" : [ "RE Job Runs Information." ],
"summary" : "Returns job summary for RE by provided data source.",
"description" : "You can retrieve the job summary by using the /{re}/{jobs}/{runinfo}/{summary}/{dataSourceId} parameters.",
"operationId" : "getJobSummary",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Specifies the name of the datasource Id for which statistics to be retrieved.",
"required" : false,
"type" : "string"
}, {
"name" : "time_filter",
"in" : "query",
"description" : "Time view with which the number of jobs run, not run job, failed CIs and failed relationships to be retrived.",
"required" : false,
"type" : "string",
"default" : "TODAY"
}, {
"name" : "activity_type",
"in" : "query",
"description" : "Activity for which the Job Summary needs to be retrieved. If value for this is not provided, summary for all activities would be retrieved.",
"required" : false,
"type" : "string",
"enum" : [ "MERGE", "COMPARE", "IDENTIFY", "RENAME", "EXECUTE", "COPY", "PURGE", "DELETE" ]
}, {
"name" : "from_date",
"in" : "query",
"description" : "Start Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
}, {
"name" : "to_date",
"in" : "query",
"description" : "End Date of Job Runs to be retrieved.",
"required" : false,
"type" : "integer",
"format" : "int64"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE job run summary"
}
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/queuedjobs" : {
"get" : {
"tags" : [ "RE Queued Jobs Information." ],
"summary" : "Get RE Jobs which are queued.",
"description" : "You can retrieve the required queued jobs information by using the /{re}/{jobs}/{runinfo}/{queuedjobs} parameters.",
"operationId" : "getQueuedJobsInfo",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "dataset_id",
"in" : "query",
"description" : "Comma separated Dataset ids for which the queued Jobs need to be retrieved. If value for this is not provided, All queued jobs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the queued Jobs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of queued Jobs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the queued Jobs need to be retrieved. If value for this is not provided, no sort info would be used.",
"required" : false,
"type" : "string",
"enum" : [ "+job_name", "-job_name" ]
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Queued Jobs need to be retrieved. If value for this is not provided, All queued Jobs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "activity_type",
"in" : "query",
"description" : "Activity for which the Queued Jobs need to be retrieved. If value for this is not provided, queued jobs for all activities would be returned.",
"required" : false,
"type" : "string",
"enum" : [ "MERGE", "COMPARE", "IDENTIFY", "RENAME", "EXECUTE", "COPY", "PURGE", "DELETE" ]
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for RE Queued Jobs."
}
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/queuedjobs/cancel" : {
"post" : {
"tags" : [ "RE Queued Jobs Information." ],
"summary" : "cancel Queued Reconciliation Job.",
"description" : "You can cancel the required Queued Reconciliation Job using the single and multiple {jobDefinitionId} parameter.",
"operationId" : "cancelJob",
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "JobInstanceIds to be canceled.",
"required" : true,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/queuedjobs/cancelall" : {
"post" : {
"tags" : [ "RE Queued Jobs Information." ],
"summary" : "cancelAll Queued Reconciliation Job.",
"description" : "You can cancel all Queued Reconciliation Job.",
"operationId" : "cancelAllJob",
"produces" : [ "application/json" ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/jobs/runinfo/{jobRunInstanceId}" : {
"get" : {
"tags" : [ "Reconcialiation Job Events Read operation for a given Job." ],
"summary" : "Gets Reconciliation Job Event details of job for a given Job Run Instance Id.",
"description" : "You can retrieve all the Job Events by using the /{re}/{jobs}/{runinfo}/{jobRunInstanceId} parameter.",
"operationId" : "getJobRunEvents",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobRunInstanceId",
"in" : "path",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job Events"
}
}
}
}
},
"/cmdb/v1.0/re/jobs/stalejobs" : {
"get" : {
"tags" : [ "Reconcialiation Job Create Read Update Delete Operations." ],
"operationId" : "getStaleJobs",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset with which the Jobs need to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "job_name",
"in" : "query",
"description" : "Job Name for which the Job Runs need to be retrieved. If value for this is not provided, All Last Job Runs would be returned.",
"required" : false,
"type" : "string"
}, {
"name" : "limit",
"in" : "query",
"description" : "Maximum Number of Jobs to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/re/jobs/{jobDefinitionId}" : {
"get" : {
"tags" : [ "Reconcialiation Job Create Read Update Delete Operations." ],
"summary" : "Gets Reconciliation Job details for a given Instance Id.",
"description" : "You can retrieve the required Reconciliation Job by using the /{jobDefinitionId} parameter.",
"operationId" : "getJob",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "InstanceId of the Job which needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job"
}
}
}
},
"delete" : {
"tags" : [ "Reconcialiation Job Create Read Update Delete Operations." ],
"summary" : "Deletes Reconciliation Job for a given instance Id.",
"description" : "You can delete the required Reconciliation Job using the /{jobDefinitionId} parameter.",
"operationId" : "deleteJob",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "InstanceId of the Reconciliation Job which needs to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"patch" : {
"tags" : [ "Reconcialiation Job Create Read Update Delete Operations." ],
"summary" : "Updates Reconcilation Job.",
"description" : "Updates the Reconcialiation Job with definition provided in request body.",
"operationId" : "updateJob",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "jobDefinitionId",
"in" : "path",
"description" : "Definition Id of the Job which needs to be updated.",
"required" : true,
"type" : "string"
}, {
"in" : "body",
"name" : "body",
"description" : "Reconciliation Job Object that is to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/serverinfo" : {
"get" : {
"tags" : [ "Returns server information like server time" ],
"summary" : "Returns server information",
"description" : "",
"operationId" : "getServerInfo",
"produces" : [ "application/json" ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ui/classes" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"operationId" : "getMinimalListOfClassForUi",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "class_type",
"in" : "query",
"required" : false,
"type" : "string",
"enum" : [ "REGULAR", "RELATIONSHIP", "FEDERATED", "FEDERATED_RELATIONSHIP" ]
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ui/classes_with_display_info" : {
"get" : {
"tags" : [ "CDM Class Create Read Update Delete Operations." ],
"operationId" : "getClassListWithDisplayDescriptors",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "class_type",
"in" : "query",
"required" : false,
"type" : "string",
"enum" : [ "REGULAR", "RELATIONSHIP", "FEDERATED", "FEDERATED_RELATIONSHIP" ]
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ui/graphdata" : {
"get" : {
"operationId" : "getUiGraphData",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "graph_walk_query",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ui/instances/{datasetId}/{namespace}/{className}" : {
"get" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"operationId" : "getUiInstancesListForIds",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "ids",
"in" : "query",
"required" : false,
"type" : "string"
}, {
"name" : "only_label_tooltip_attrributes",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "dataset_mask",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "0"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ui/instances/{datasetId}/{namespace}/{className}/{instanceId}" : {
"get" : {
"tags" : [ "Instance/s Create Read Update Delete Operations." ],
"operationId" : "getUiInstance",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "datasetId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "namespace",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "className",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "instanceId",
"in" : "path",
"required" : true,
"type" : "string"
}, {
"name" : "only_label_tooltip_attrributes",
"in" : "query",
"required" : false,
"type" : "boolean",
"default" : true
}, {
"name" : "dataset_mask",
"in" : "query",
"required" : false,
"type" : "string",
"default" : "0"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/ui/querybypath" : {
"get" : {
"tags" : [ "Instanc API for query By Path." ],
"operationId" : "queryByPathForUIByGet",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "qualification",
"in" : "query",
"required" : false,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/uifilters" : {
"get" : {
"tags" : [ "Filters Create Read Update Operations" ],
"summary" : "Get All Filters.",
"description" : "Returns all filters.",
"operationId" : "getAllFilters",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Starting index of the number of filters to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "End limit of the filters to be retrieved.",
"required" : false,
"type" : "integer",
"default" : 500,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Comma separated Sort name with which the Filters need to be retrieved.",
"required" : false,
"type" : "string",
"enum" : [ "+filter_name", "-filter_name" ]
}, {
"name" : "filter_name",
"in" : "query",
"description" : "Filtering string for filter name.",
"required" : false,
"type" : "string"
}, {
"name" : "filter_type",
"in" : "query",
"description" : "Filtering criteria based on Filter type.",
"required" : false,
"type" : "string",
"enum" : [ "GLOBAL", "PERSONAL" ]
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
},
"post" : {
"tags" : [ "Filters Create Read Update Operations" ],
"summary" : "Create Filter.",
"description" : "Create Filter.",
"operationId" : "createFilter",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Filter object to be created.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Filter"
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"type" : "string"
}
}
}
},
"patch" : {
"tags" : [ "Filters Create Read Update Operations" ],
"summary" : "Update Filter.",
"description" : "Update Filter.",
"operationId" : "updateFilter",
"consumes" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "body",
"description" : "Filter object to be updated.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Filter"
}
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/uifilters/{filterId}" : {
"get" : {
"tags" : [ "Filters Create Read Update Operations" ],
"summary" : "Get Single Filter.",
"description" : "Returns uiFilter based on filter Id.",
"operationId" : "getFilter",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "filterId",
"in" : "path",
"description" : "filterId of the filter that needs to be retrieved.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Filter"
}
}
}
},
"delete" : {
"tags" : [ "Filters Create Read Update Operations" ],
"summary" : "Deletes single instance of UI Filter for a given instance Id.",
"description" : "You can delete the required instance by using the /{instanceId} parameter.",
"operationId" : "deleteFilter",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "filterId",
"in" : "path",
"description" : "InstanceId for which an instance needs to be deleted.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"default" : {
"description" : "successful operation"
}
}
}
},
"/cmdb/v1.0/userinfo" : {
"get" : {
"tags" : [ "Get Logged in user basic details." ],
"summary" : "Gets UserInfo",
"description" : "Gets UserInfo for logged in user.",
"operationId" : "get",
"produces" : [ "application/json" ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Versions"
}
}
}
}
},
"/cmdb/v1.0/versions" : {
"get" : {
"tags" : [ "Get Application Version/s." ],
"summary" : "Gets the Version for the applications installed on the server.",
"description" : "Get version information for all or specific applications installed on the server.",
"operationId" : "get",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "applicationId",
"in" : "query",
"description" : "Application Ids for which version information needs to be retrieved.",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"schema" : {
"$ref" : "#/definitions/Domain object for Versions"
}
}
}
}
}
},
"securityDefinitions" : {
"api_key" : {
"type" : "apiKey",
"name" : "api_key",
"in" : "header"
}
},
"definitions" : {
"AIDataStore" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
}
}
},
"AIDataStoreDetails" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "MSSQL", "ORACLE", "MySQL", "DB2", "SYBASE", "CSV", "XML", "ARSYSTEM" ]
},
"host_name" : {
"type" : "string"
},
"port" : {
"type" : "integer",
"format" : "int32"
},
"database_name" : {
"type" : "string"
},
"user_name" : {
"type" : "string"
},
"password" : {
"type" : "string"
},
"server_name" : {
"type" : "string"
},
"storage_type" : {
"type" : "string"
},
"file_path" : {
"type" : "string"
},
"attachment_set_name" : {
"type" : "string"
},
"carte_server_name" : {
"type" : "string"
},
"is_container" : {
"type" : "boolean"
},
"database_instance_name" : {
"type" : "string"
},
"ar_server_name" : {
"type" : "string"
}
}
},
"AIDataStoreService" : {
"type" : "object"
},
"AIJob" : {
"type" : "object",
"properties" : {
"jbDirectoryName" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"job_id" : {
"type" : "string"
},
"job_name" : {
"type" : "string"
},
"job_directory_id" : {
"type" : "string"
},
"job_directory_path" : {
"type" : "string"
},
"job_created_user" : {
"type" : "string"
},
"job_modified_user" : {
"type" : "string"
},
"job_created_date" : {
"type" : "string"
},
"job_modified_date" : {
"type" : "string"
},
"job_description" : {
"type" : "string"
}
}
},
"AIJobService" : {
"type" : "object"
},
"AIStartJobCommand" : {
"type" : "object",
"properties" : {
"aiJobService" : {
"$ref" : "#/definitions/AIJobService"
},
"logger" : {
"$ref" : "#/definitions/Logger"
},
"jobId" : {
"type" : "string"
},
"jobName" : {
"type" : "string"
},
"jobDirName" : {
"type" : "string"
}
}
},
"AIStopJobCommand" : {
"type" : "object",
"properties" : {
"aiJobService" : {
"$ref" : "#/definitions/AIJobService"
},
"logger" : {
"$ref" : "#/definitions/Logger"
},
"jobId" : {
"type" : "string"
},
"jobName" : {
"type" : "string"
},
"jobDirName" : {
"type" : "string"
}
}
},
"AR Server information" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"server_info_map" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"description" : "AR Server information when given a param"
},
"ActivityCommand" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"activity" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}
}
},
"ActivityGroupAssociation" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"source_dataset_id" : {
"type" : "string"
},
"group_id" : {
"type" : "string"
},
"group_name" : {
"type" : "string"
},
"generate_ids" : {
"type" : "boolean"
},
"namespace" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
}
}
},
"AttachmentLimit" : {
"type" : "object",
"properties" : {
"attachment_pool_name" : {
"type" : "string"
},
"max_size" : {
"type" : "integer",
"format" : "int64"
}
}
},
"AttachmentPoolLimit" : {
"type" : "object"
},
"Attribute" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "CORE_INTERNAL", "CORE", "REGULAR" ]
},
"datatype" : {
"type" : "string",
"enum" : [ "INTEGER", "REAL", "CHAR", "DIARY", "ENUM", "TIME", "DECIMAL", "ATTACHMENT", "CURRENCY", "DATE", "TIME_OF_DAY", "ATTACHMENT_POOL" ]
},
"characteristics" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"limit" : {
"$ref" : "#/definitions/AttributeLimit"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"new_name" : {
"type" : "string"
},
"attribute_id" : {
"type" : "string"
},
"field_id" : {
"type" : "integer",
"format" : "int32"
},
"entry_mode" : {
"type" : "string",
"enum" : [ "REQUIRED", "OPTIONAL", "SYSTEM", "DISPLAY_ONLY" ]
},
"default_value" : {
"type" : "object"
},
"class_id" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"custom_characteristics" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
}
},
"AttributeLimit" : {
"type" : "object",
"properties" : {
"attachment_pool_limit" : {
"$ref" : "#/definitions/AttachmentPoolLimit"
},
"attachment_limit" : {
"$ref" : "#/definitions/AttachmentLimit"
},
"char_limit" : {
"$ref" : "#/definitions/CharLimit"
},
"currency_limit" : {
"$ref" : "#/definitions/CurrencyLimit"
},
"date_limit" : {
"$ref" : "#/definitions/DateLimit"
},
"decimal_limit" : {
"$ref" : "#/definitions/DecimalLimit"
},
"diary_limit" : {
"$ref" : "#/definitions/DiaryLimit"
},
"enum_limit" : {
"$ref" : "#/definitions/EnumLimit"
},
"int_limit" : {
"$ref" : "#/definitions/IntegerLimit"
},
"real_limit" : {
"$ref" : "#/definitions/RealLimit"
},
"time_limit" : {
"$ref" : "#/definitions/TimeLimit"
},
"time_of_day_limit" : {
"$ref" : "#/definitions/TimeOfDayLimit"
}
}
},
"AttributeService" : {
"type" : "object"
},
"AttributeValue" : {
"type" : "object",
"properties" : {
"attribute_name" : {
"type" : "string"
},
"attribute_value" : {
"type" : "object"
}
}
},
"AuditInfo" : {
"type" : "object",
"properties" : {
"operation" : {
"type" : "string"
},
"changed_by" : {
"type" : "string"
},
"audit_date" : {
"type" : "string",
"format" : "date-time"
},
"changed_attribute_name_list" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attribute_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AttributeValue"
}
},
"form_name" : {
"type" : "string"
}
}
},
"AuditService" : {
"type" : "object"
},
"AutoImpactRule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for NE NERule"
}, {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"source_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"destination_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"is_class_applies_to_children" : {
"type" : "boolean"
},
"is_source_class_applies_to_children" : {
"type" : "boolean"
},
"is_destination_class_applies_to_children" : {
"type" : "boolean"
},
"qualification" : {
"type" : "string"
},
"source_qualification" : {
"type" : "string"
},
"destination_qualification" : {
"type" : "string"
},
"has_impact" : {
"type" : "string"
},
"impact_direction" : {
"type" : "string"
},
"impact_propagation_model" : {
"type" : "string"
},
"impact_weight" : {
"type" : "string"
}
}
} ]
},
"BitSet" : {
"type" : "object",
"properties" : {
"empty" : {
"type" : "boolean"
}
}
},
"CMDBClass" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "REGULAR", "RELATIONSHIP", "FEDERATED", "FEDERATED_RELATIONSHIP" ]
},
"characteristics" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"class_id" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"super_class_id" : {
"type" : "string"
},
"primary_key_attribute_names" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"custom_characteristics" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"super_class_key" : {
"$ref" : "#/definitions/class_name_key"
},
"indices" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ClassIndex"
}
},
"audit" : {
"$ref" : "#/definitions/ClassAuditInfo"
},
"relationship_info" : {
"$ref" : "#/definitions/CMDBRelationship"
},
"attributes" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Attribute"
}
},
"display_descriptor" : {
"$ref" : "#/definitions/Domain object for Displaying CI Node UI Info."
},
"class_owner" : {
"type" : "string"
}
}
},
"CMDBClassArchiveAgeInfo" : {
"type" : "object",
"properties" : {
"global" : {
"type" : "integer",
"format" : "int32"
},
"custom" : {
"type" : "integer",
"format" : "int32"
}
}
},
"CMDBClassArchiveInfo" : {
"type" : "object",
"properties" : {
"qualification" : {
"type" : "string"
},
"days" : {
"type" : "integer",
"format" : "int32"
},
"archive_form_name" : {
"type" : "string"
}
}
},
"CMDBQueryResultGraphFormat" : {
"type" : "object",
"properties" : {
"nodes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CMDBQueryResultInstanceList"
}
},
"edges" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CMDBQueryResultInstanceList"
}
}
}
},
"CMDBQueryResultInstanceList" : {
"type" : "object",
"properties" : {
"alias" : {
"type" : "string"
},
"instances" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
}
}
},
"CMDBRelationship" : {
"type" : "object",
"properties" : {
"cardinality" : {
"type" : "string",
"enum" : [ "NONE", "ONE_TO_ONE", "MANY_TO_ONE", "ONE_TO_MANY", "MANY_TO_MANY" ]
},
"source_endpoint_info" : {
"$ref" : "#/definitions/RelEndpointInfo"
},
"destination_endpoint_info" : {
"$ref" : "#/definitions/RelEndpointInfo"
},
"cascade_delete" : {
"type" : "boolean"
},
"weak_relationship" : {
"type" : "boolean"
},
"weak_propagated_attributes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/PropagatedAttributeInfo"
}
}
}
},
"CMDBSavedQuery" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"category" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"query" : {
"type" : "string"
},
"format" : {
"type" : "string"
}
}
},
"CharLimit" : {
"type" : "object",
"properties" : {
"pattern" : {
"type" : "string"
},
"max_length" : {
"type" : "integer",
"format" : "int32"
},
"list_format" : {
"type" : "string"
},
"menu_style" : {
"type" : "string",
"enum" : [ "APPEND", "OVERWRITE" ]
},
"char_menu" : {
"type" : "string"
},
"qbe_match" : {
"type" : "string",
"enum" : [ "ANYWHERE", "LEADING", "EQUAL" ]
}
}
},
"Charset" : {
"type" : "object",
"properties" : {
"registered" : {
"type" : "boolean"
}
}
},
"CiImpactSimulationInfo" : {
"type" : "object",
"properties" : {
"ciInstanceId" : {
"type" : "string"
},
"state" : {
"type" : "string"
},
"priority" : {
"type" : "string"
}
}
},
"CiMapping" : {
"type" : "object",
"properties" : {
"deleteOrphan" : {
"type" : "boolean"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"logical_name" : {
"type" : "string"
},
"delta_column" : {
"type" : "string"
},
"is_delete_orphan" : {
"type" : "boolean"
},
"update_source_column" : {
"type" : "string"
},
"update_source_datatype" : {
"type" : "string"
},
"schema_name" : {
"type" : "string"
},
"table_name" : {
"type" : "string"
},
"file_name" : {
"type" : "string"
},
"getxPath" : {
"type" : "string"
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CiMappingEntry"
}
}
}
},
"CiMappingEntry" : {
"type" : "object",
"properties" : {
"source" : {
"type" : "string"
},
"target" : {
"type" : "string"
},
"datatype" : {
"type" : "string"
},
"type" : {
"type" : "integer",
"format" : "int32"
},
"constant" : {
"type" : "boolean"
},
"primaryKey" : {
"type" : "boolean"
},
"is_primary_key" : {
"type" : "boolean"
},
"is_constant" : {
"type" : "boolean"
}
}
},
"ClassAllowedRelationship" : {
"type" : "object",
"properties" : {
"rel_Class" : {
"type" : "string"
},
"source_class" : {
"type" : "string"
},
"destination_class" : {
"type" : "string"
}
}
},
"ClassAuditInfo" : {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "NONE", "COPY", "LOG" ]
},
"log_form" : {
"type" : "string"
},
"qualification_string" : {
"type" : "string"
},
"audit_only_changed_fields" : {
"type" : "string",
"enum" : [ "DEFAULT", "YES", "NO" ]
}
}
},
"ClassCIMapping" : {
"type" : "object",
"properties" : {
"ci" : {
"type" : "string"
},
"category" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"item" : {
"type" : "string"
},
"attributes_to_set" : {
"type" : "string"
}
}
},
"ClassIndex" : {
"type" : "object",
"properties" : {
"unique" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"primary_key" : {
"type" : "boolean"
},
"index_attribute_names" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
}
}
},
"ClassNormalizedRelationship" : {
"type" : "object",
"properties" : {
"value_for_name_Attr" : {
"type" : "string"
},
"rel_Class" : {
"type" : "string"
},
"source_class" : {
"type" : "string"
},
"destination_class" : {
"type" : "string"
},
"cdm_equivalent_class" : {
"type" : "string"
}
}
},
"ClassService" : {
"type" : "object"
},
"ClientType" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
}
}
},
"CommandFactory" : {
"type" : "object",
"properties" : {
"logger" : {
"$ref" : "#/definitions/Logger"
},
"neStartJobCommand" : {
"$ref" : "#/definitions/NEStartJobCommand"
},
"neCancelJobCommand" : {
"$ref" : "#/definitions/NECancelJobCommand"
},
"reStartJobCommand" : {
"$ref" : "#/definitions/REStartJobCommand"
},
"reCancelJobCommand" : {
"$ref" : "#/definitions/RECancelJobCommand"
},
"aiStartJobCommand" : {
"$ref" : "#/definitions/AIStartJobCommand"
},
"aiStopJobCommand" : {
"$ref" : "#/definitions/AIStopJobCommand"
},
"noeSubscribeCommand" : {
"$ref" : "#/definitions/NOESubscribeCommand"
},
"noeUnSubscribeCommand" : {
"$ref" : "#/definitions/NOEUnSubscribeCommand"
},
"reqChangedCisCommand" : {
"$ref" : "#/definitions/RequestChangedCIsCommand"
},
"runArchiveCommand" : {
"$ref" : "#/definitions/RunArchiveCommand"
}
}
},
"CommonService" : {
"type" : "object",
"properties" : {
"applicationContext" : {
"$ref" : "#/definitions/InternalCallContext"
}
}
},
"CompareActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"compare_to_dataset_id" : {
"type" : "string"
},
"compare_with_dataset_id" : {
"type" : "string"
},
"workflow_execution_group_name" : {
"type" : "string"
},
"workflow_execution_group_id" : {
"type" : "string"
},
"exclusion_rules" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ComparisonRule"
}
}
}
} ]
},
"ComparisonRule" : {
"type" : "object",
"properties" : {
"rule_id" : {
"type" : "string"
},
"rule_namespace" : {
"type" : "string"
},
"rule_classname" : {
"type" : "string"
},
"class_id" : {
"type" : "string"
},
"rule_attribute_name" : {
"type" : "string"
}
}
},
"CompletenessExceptionDetail" : {
"type" : "object",
"properties" : {
"exceptionType" : {
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"name" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"instance_id" : {
"type" : "string"
},
"reconclilation_id" : {
"type" : "string"
},
"exception_since" : {
"type" : "string"
},
"exception_type" : {
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
},
"error_description" : {
"type" : "string"
},
"recommended_action" : {
"type" : "string"
},
"missing_attributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"attribute_source_datasets" : {
"type" : "string"
},
"missing_attributes_count" : {
"type" : "integer",
"format" : "int32"
}
}
},
"Component" : {
"type" : "object",
"properties" : {
"components" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"selected" : {
"type" : "string"
}
}
},
"ConfigurationSettingsService" : {
"type" : "object"
},
"CopyActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"source_dataset_id" : {
"type" : "string"
},
"target_dataset_id" : {
"type" : "string"
},
"include_child_ci" : {
"type" : "boolean"
},
"identity_required" : {
"type" : "boolean"
},
"copy_relationship" : {
"type" : "string",
"enum" : [ "BY_QUALIFIER", "COPY_ALL" ]
},
"collision_resolution" : {
"type" : "string",
"enum" : [ "OVERWRITE", "DISPLAY_ERROR" ]
}
}
} ]
},
"CurrencyDetail" : {
"type" : "object",
"properties" : {
"precision" : {
"type" : "integer",
"format" : "int32"
},
"currency_code" : {
"type" : "string"
}
}
},
"CurrencyLimit" : {
"type" : "object",
"properties" : {
"precision" : {
"type" : "integer",
"format" : "int32"
},
"min_value" : {
"type" : "number"
},
"max_value" : {
"type" : "number"
},
"allowable_currencies" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CurrencyDetail"
}
},
"functional_currencies" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CurrencyDetail"
}
}
}
},
"CustomEnumItem" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"format" : "int32"
},
"name" : {
"type" : "string"
}
}
},
"CustomRule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for NE NERule"
}, {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"source_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"destination_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"is_class_applies_to_children" : {
"type" : "boolean"
},
"is_source_class_applies_to_children" : {
"type" : "boolean"
},
"is_destination_class_applies_to_children" : {
"type" : "boolean"
},
"qualification" : {
"type" : "string"
},
"source_qualification" : {
"type" : "string"
},
"destination_qualification" : {
"type" : "string"
},
"feature_properties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FeatureProperty"
}
},
"group_name" : {
"type" : "string"
}
}
} ]
},
"DailyJobSchedule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Job Schedule"
}, {
"type" : "object"
} ]
},
"DashboardConfigService" : {
"type" : "object"
},
"DashboardSchedule" : {
"type" : "object",
"properties" : {
"featureType" : {
"type" : "string",
"enum" : [ "DATASOURCES", "KPI" ]
},
"dashboardSchedule" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
}
}
},
"DataSourceStatisticsList" : {
"type" : "object",
"properties" : {
"datasources" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for DataSource"
}
},
"data_captured_time" : {
"type" : "string"
},
"is_utility_run" : {
"type" : "boolean"
},
"utility_status" : {
"type" : "string"
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for displaying the DataSources statistics."
},
"DataSourceStatisticsSummary" : {
"type" : "object",
"properties" : {
"total_num_of_datasources" : {
"type" : "integer",
"format" : "int32"
},
"num_datasoures_without_error" : {
"type" : "integer",
"format" : "int32"
},
"num_datasoures_with_error" : {
"type" : "integer",
"format" : "int32"
},
"data_captured_time" : {
"type" : "string"
},
"num_datasets_without_datasource" : {
"type" : "integer",
"format" : "int32"
},
"total_num_of_datasets" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for DataSources statistics summary."
},
"Dataset" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"dataset_type" : {
"type" : "string",
"enum" : [ "REGULAR", "OVERLAY" ]
},
"dataset_security_permissions" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"accessibility" : {
"type" : "string",
"enum" : [ "WRITABLE", "READ_ONLY", "WRITABLE_BY_CLIENT_ONLY" ]
},
"last_modified_date" : {
"type" : "string"
},
"source_dataset_id" : {
"type" : "string"
}
}
},
"DatasetService" : {
"type" : "object"
},
"DateLimit" : {
"type" : "object",
"properties" : {
"min_date" : {
"type" : "string",
"format" : "date-time"
},
"max_date" : {
"type" : "string",
"format" : "date-time"
}
}
},
"DecimalLimit" : {
"type" : "object",
"properties" : {
"precision" : {
"type" : "integer",
"format" : "int32"
},
"min_value" : {
"type" : "number"
},
"max_value" : {
"type" : "number"
}
}
},
"DeleteActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"delete_instances" : {
"type" : "string",
"enum" : [ "IDENTIFIED_AND_UNIDENTIFIED", "IDENTIFIED", "UNIDENTIFIED" ]
},
"source_dataset_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
} ]
},
"DiaryLimit" : {
"type" : "object"
},
"Domain for Query By Path response" : {
"type" : "object",
"properties" : {
"num_matches" : {
"type" : "integer",
"format" : "int32"
},
"list_result" : {
"type" : "array",
"items" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Domain object for Instance"
}
}
},
"graph_result" : {
"$ref" : "#/definitions/CMDBQueryResultGraphFormat"
}
},
"description" : "Domain for Query By Path response"
},
"Domain object for AI Job Run Info." : {
"type" : "object",
"properties" : {
"job_id" : {
"type" : "string"
},
"job_name" : {
"type" : "string"
},
"job_directory_path" : {
"type" : "string"
},
"job_run_id" : {
"type" : "string"
},
"job_status" : {
"type" : "string",
"enum" : [ "Running", "Completed", "Failed", "Stopped", "Paused" ]
},
"errors" : {
"type" : "integer",
"format" : "int64"
},
"job_start_date" : {
"type" : "string"
},
"job_end_date" : {
"type" : "string"
},
"records_updated" : {
"type" : "integer",
"format" : "int64"
},
"records_input" : {
"type" : "integer",
"format" : "int64"
},
"records_rejected" : {
"type" : "integer",
"format" : "int64"
},
"records_added" : {
"type" : "integer",
"format" : "int64"
},
"records_written" : {
"type" : "integer",
"format" : "int64"
},
"records_read" : {
"type" : "integer",
"format" : "int64"
},
"carte_server_instanceid" : {
"type" : "string"
},
"carte_url" : {
"type" : "string"
},
"no_of_job_runs" : {
"type" : "integer",
"format" : "int64"
},
"job_minimal_log" : {
"type" : "string"
},
"transformations_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/TransRunInfo"
}
}
},
"description" : "The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here."
},
"Domain object for AI Job Runs Agrgated Summary with Records Added and Updated" : {
"type" : "object",
"properties" : {
"num_records_added" : {
"type" : "integer",
"format" : "int64"
},
"num_records_updated" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "Domain object for Agregated AI job run summary"
},
"Domain object for AI Jobs Run History.." : {
"type" : "object",
"properties" : {
"job_runs_history" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for AI Job Run Info."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The job runs of a given job are contained here."
},
"Domain object for AI Jobs Run Info." : {
"type" : "object",
"properties" : {
"last_job_run_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for AI Job Run Info."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The last job runs of all required jobs are contained here."
},
"Domain object for AI Jobs." : {
"type" : "object",
"properties" : {
"jobs_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AIJob"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "jobs lists are contained here."
},
"Domain object for AI data-stores." : {
"type" : "object",
"properties" : {
"datastores_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/AIDataStore"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "data-stores lists are contained here."
},
"Domain object for AI last job run summary" : {
"type" : "object",
"properties" : {
"num_jobs_with_runs" : {
"type" : "integer",
"format" : "int64"
},
"num_jobs_with_no_runs" : {
"type" : "integer",
"format" : "int64"
},
"num_all_jobs" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "Domain object for AI job run summary"
},
"Domain object for BMC_FederatedDataInterface" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"instance_id" : {
"type" : "string"
},
"product_id" : {
"type" : "string"
},
"class_id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"ar_access_method" : {
"type" : "string",
"enum" : [ "NATIVE", "WEB" ]
},
"ar_server_name" : {
"type" : "string"
},
"ar_form_name" : {
"type" : "string"
},
"ar_view_name" : {
"type" : "string"
},
"ar_server_port" : {
"type" : "string"
},
"ar_query" : {
"type" : "string"
},
"federation_access_method" : {
"type" : "string",
"enum" : [ "AR", "UNDEFINED", "URL", "RUNPROCESS", "MANUAL", "DATASTORE", "CLASS" ]
},
"federation_access_string" : {
"type" : "string"
},
"federation_action_type" : {
"type" : "string",
"enum" : [ "LAUNCH", "DATA" ]
},
"cmdb_row_level_security" : {
"type" : "string"
},
"cmdb_write_security" : {
"type" : "string"
},
"federation_product_name" : {
"type" : "string"
}
},
"description" : "This contains the domain object for BMC_FederatedDataInterface"
},
"Domain object for BMC_FederatedInterfaceLink" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
}, "instance_id" : {
"type" : "string"
},
"class_id" : {
"type" : "string"
},
"cmdb_row_level_security" : {
"type" : "string"
},
"cmdb_write_security" : {
"type" : "string"
},
"destination_class_id" : {
"type" : "string"
},
"source_class_id" : {
"$ref" : "#/definitions/class_name_key"
},
"destination_instance_id" : {
"type" : "string"
},
"source_instance_id" : {
"type" : "string"
},
"source_dataset_id" : {
"type" : "string"
},
"qualification" : {
"type" : "string"
},
"link_method" : {
"type" : "string",
"enum" : [ "CLASS", "INSTANCE" ]
},
"link_qualification" : {
"type" : "string"
},
"link_query" : {
"type" : "string"
}
},
"description" : "This contains the domain object for BMC_FederatedInterfaceLink"
},
"Domain object for BMC_FederatedProduct" : {
"type" : "object",
"properties" : {
"description" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"instance_id" : {
"type" : "string"
},
"product_code" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"class_id" : {
"type" : "string"
},
"cmdb_row_level_security" : {
"type" : "string"
},
"cmdb_write_security" : {
"type" : "string"
}
},
"description" : "This contains the domain object for BMC_FederatedProduct"
},
"Domain object for Bulk Operation." : {
"type" : "object",
"properties" : {
"instance" : {
"$ref" : "#/definitions/Domain object for Instance"
},
"deleteOption" : {
"type" : "string"
},
"operation" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE" ]
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
}
}
},
"Domain object for CIUpdates Summary" : {
"type" : "object",
"properties" : {
"total_cis" : {
"type" : "integer",
"format" : "int32"
},
"total_class_cis" : {
"type" : "integer",
"format" : "int32"
},
"total_relationship_cis" : {
"type" : "integer",
"format" : "int32"
},
"added_class_cis" : {
"type" : "integer",
"format" : "int32"
},
"edited_class_cis" : {
"type" : "integer",
"format" : "int32"
},
"mark_as_deleted_class_cis" : {
"type" : "integer",
"format" : "int32"
},
"added_relationship_cis" : {
"type" : "integer",
"format" : "int32"
},
"edited_relationship_cis" : {
"type" : "integer",
"format" : "int32"
},
"mark_as_deleted_relationship_cis" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for CIUpdates Summary"
},
"Domain object for CIUpdates detail" : {
"type" : "object",
"properties" : {
"ci_instance_id" : {
"type" : "string"
},
"ci_name" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"update_date" : {
"type" : "string"
},
"ci_operation" : {
"type" : "string",
"enum" : [ "CREATED", "EDITED", "MARK_AS_DELETED" ]
}
},
"description" : "Domain object for CIUpdates detail"
},
"Domain object for Carte Server details." : {
"type" : "object",
"properties" : {
"server_name" : {
"type" : "string"
},
"host_name" : {
"type" : "string"
},
"port" : {
"type" : "string"
},
"is_default" : {
"type" : "boolean"
}
},
"description" : "Carte Servers details from UDM:Config."
},
"Domain object for Carte Servers List." : {
"type" : "object",
"properties" : {
"carte_servers_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Carte Server details."
}
}
},
"description" : "Carte Servers List in UDM:Config."
},
"Domain object for Centralized Configuration Settings" : {
"type" : "object",
"properties" : {
"settings" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Node"
}
},
"apply_to_all_datasets" : {
"type" : "boolean"
}
},
"description" : "The list of ConfigurationSettings Objects are contained here."
},
"Domain object for Completeness Config" : {
"type" : "object",
"properties" : {
"instance_id" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"attribute_name" : {
"type" : "string"
},
"priority" : {
"type" : "string"
}
}
},
"Domain object for Completeness Configs." : {
"type" : "object",
"properties" : {
"configs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Completeness Config"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "All the completeness configs are contained here."
},
"Domain object for DataFlowStatistics" : {
"type" : "object",
"properties" : {
"data_captured_time" : {
"type" : "string",
"format" : "date-time"
},
"utility_status" : {
"type" : "string"
},
"num_class_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"num_rel_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"num_class_cis_pending_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"num_rel_cis_pending_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_pending_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"num_class_cis_successfully_normalized" : {
"type" : "integer",
"format" : "int64"
},
"num_rel_cis_successfully_normalized" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_successfully_normalized" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_for_normalized" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_failed_to_id_for_reconcile" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_failed_to_merge_for_reconcile" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_pending_to_id_for_reconcile" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_pending_to_merge_for_reconcile" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_Successfully_to_id_for_reconciled" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_successfully_to_merge_for_reconciled" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_to_id_for_reconciled" : {
"type" : "integer",
"format" : "int64"
},
"total_num_cis_to_merge_for_reconciled" : {
"type" : "integer",
"format" : "int64"
},
"num_datasets_without_error" : {
"type" : "integer",
"format" : "int32"
},
"num_datasets_with_error" : {
"type" : "integer",
"format" : "int32"
},
"num_datasets_without_datasource" : {
"type" : "integer",
"format" : "int32"
},
"ai_import_counts" : {
"$ref" : "#/definitions/Domain object for AI Job Runs Agrgated Summary with Records Added and Updated"
}
},
"description" : "Domain object for DataFlowStatistics"
},
"Domain object for DataSource" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"related_dataset_id" : {
"type" : "string"
},
"related_dataset_type" : {
"type" : "string",
"enum" : [ "REGULAR", "OVERLAY" ]
},
"provider_type" : {
"type" : "string",
"enum" : [ "VIA_API", "ATRIUM_INTEGRATOR", "MANUAL", "OTHER" ]
},
"description" : {
"type" : "string"
},
"added_by" : {
"type" : "string"
},
"other_provider_type_details" : {
"type" : "string"
},
"total_num_of_cis" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_pending_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_pending_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_pending_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_pending_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_failed_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_pending_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_pending_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_failed_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_not_applicable_for_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_not_applicable_for_normalization" : {
"type" : "integer",
"format" : "int32"
},
"last_modified_date" : {
"type" : "string",
"format" : "date-time"
},
"num_cis_pending_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_pending_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_pending_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_failed_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_failed_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_failed_to_reconcile" : {
"type" : "integer",
"format" : "int32"
},
"num_cis_pending_to_reconcile" : {
"type" : "integer",
"format" : "int32"
},
"getisDatasourceStatAvailable" : {
"type" : "boolean"
},
"excluded_classes_datasources" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Excluded Classes Info"
}
}
},
"description" : "Domain object for DataSource"
},
"Domain object for Dataflow summary" : {
"type" : "object",
"properties" : {
"data_flow_run_statistics" : {
"$ref" : "#/definitions/Domain object for DataFlowStatistics"
},
"num_datasources" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "Domain object for Dataflow summary"
},
"Domain object for Displaying CI Node UI Info." : {
"type" : "object",
"properties" : {
"icon_identifier" : {
"type" : "string"
},
"icon_font" : {
"type" : "string"
},
"link_color" : {
"type" : "string"
},
"tooltip_fields" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"label_fields" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "Domain object for Displaying CI Node UI Info. It represents display information of a class as well."
},
"Domain object for Excluded Classes Info" : {
"type" : "object",
"properties" : {
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"instance_count" : {
"type" : "integer",
"format" : "int32"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
}
}
},
"Domain object for Failed CI for given job run." : {
"type" : "object",
"properties" : {
"ci_name" : {
"type" : "string"
},
"ci_instance_id" : {
"type" : "string"
},
"dataset_id" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"error_description" : {
"type" : "string"
},
"recommended_action" : {
"type" : "string"
},
"ci_type" : {
"type" : "string",
"enum" : [ "CI", "RELATIONSHIP" ]
},
"ci_class_form_name" : {
"type" : "string"
}
},
"description" : "Failed CI reporting for given job run."
},
"Domain object for Failed CIs for given job run." : {
"type" : "object",
"properties" : {
"job_run_failed_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Failed CI for given job run."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "Failed CIs reporting for given job run."
},
"Domain object for Federated Link for given instance" : {
"type" : "object",
"properties" : {
"federated_group_name" : {
"type" : "string"
},
"federated_definition" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedDataInterface"
},
"federated_link_name" : {
"type" : "string"
}
},
"description" : "This contains the domain object for Federated Link for given instance"
},
"Domain object for Federation Vendor Table Column List" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"column_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Federation Vendor Table Field"
}
}
},
"description" : "This contains the domain object for Federation Vendor Table Column List"
},
"Domain object for Federation Vendor Table Field" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"name" : {
"type" : "string"
},
"datatype" : {
"type" : "string"
},
"limit" : {
"$ref" : "#/definitions/AttributeLimit"
}
},
"description" : "This contains the domain object for Federation Vendor Table Field"
},
"Domain object for Federation Vendor Tables" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"table_list" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "This contains the domain object for Federation Vendor Tables"
},
"Domain object for FederationPluginConfig" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"plugin_id" : {
"type" : "string"
},
"plugin_name" : {
"type" : "string"
},
"plugin_type" : {
"type" : "string"
},
"connection_string" : {
"type" : "string"
},
"cmdb_row_level_security" : {
"type" : "string"
},
"cmdb_write_security" : {
"type" : "string"
}
},
"description" : "This contains the domain object for FederationPluginConfig"
},
"Domain object for Graph Walk Query" : {
"type" : "object",
"properties" : {
"dataset_id" : {
"type" : "string"
},
"start_node" : {
"$ref" : "#/definitions/Domain object for Graph Walk Start Node"
},
"dataset_mask" : {
"type" : "integer",
"format" : "int32"
},
"num_levels_to_traverse" : {
"type" : "integer",
"format" : "int32"
},
"limit" : {
"type" : "integer",
"format" : "int32"
},
"query_mode" : {
"type" : "string",
"enum" : [ "STOP_IF_NO_MATCH_FOUND", "STOP_IF_MATCH_FOUND", "WALK_COMPLETE_GRAPH" ]
},
"default_return_relationship_ci_attributes" : {
"type" : "string",
"enum" : [ "NONE", "NONHIDDEN", "ALL" ]
},
"default_return_class_ci_attributes" : {
"type" : "string",
"enum" : [ "NONE", "NONHIDDEN", "ALL" ]
},
"default_return_class_cis" : {
"type" : "string",
"enum" : [ "NONE", "ALL" ]
},
"relationship_selectors_filters" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Graph Walk Relationship"
}
},
"class_selectors_filters" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Graph Walk Selector and Filter"
}
},
"chunk_id" : {
"type" : "string"
}
},
"description" : "Domain object for Graph Walk Query"
},
"Domain object for Graph Walk Relationship" : {
"type" : "object",
"properties" : {
"qualification" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"return_attributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"direction_to_walk" : {
"type" : "string",
"enum" : [ "OUT", "IN", "BOTH", "IN_OUT" ]
},
"is_impact_graph_walk" : {
"type" : "boolean"
}
},
"description" : "Domain object for Graph Walk Relationship"
},
"Domain object for Graph Walk Result" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"relationship_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"class_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"next_chunk_id" : {
"type" : "string"
}
},
"description" : "Domain object for Graph Walk Result"
},
"Domain object for Graph Walk Result with UI Display Info" : {
"type" : "object",
"properties" : {
"relationship_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance with Display Info."
}
},
"class_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance with Display Info."
}
},
"next_chunk_id" : {
"type" : "string"
}
},
"description" : "Domain object for Graph Walk Result with UI Display Info"
},
"Domain object for Graph Walk Selector and Filter" : {
"type" : "object",
"properties" : {
"qualification" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"return_attributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "Domain object for Graph Walk Selector and Filter"
},
"Domain object for Graph Walk Start Node" : {
"type" : "object",
"properties" : {
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"instance_id" : {
"type" : "string"
}
},
"description" : "Domain object for Graph Walk Start Node"
},
"Domain object for Instance" : {
"type" : "object",
"properties" : {
"instance_id" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"dataset_id" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
}
}
},
"Domain object for Instance with Display Info." : {
"type" : "object",
"properties" : {
"instance_id" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"dataset_id" : {
"type" : "string"
},
"attributes" : {
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"display_id" : {
"type" : "string"
},
"class_type" : {
"type" : "string",
"enum" : [ "REGULAR", "RELATIONSHIP", "FEDERATED", "FEDERATED_RELATIONSHIP" ]
},
"impact_simulation_info" : {
"$ref" : "#/definitions/CiImpactSimulationInfo"
},
"display_descriptor" : {
"$ref" : "#/definitions/Domain object for Displaying CI Node UI Info."
}
}
},
"Domain object for Instances." : {
"type" : "object",
"properties" : {
"instance_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"Domain object for Job Schedule" : {
"type" : "object",
"discriminator" : "type",
"properties" : {
"carteServer" : {
"type" : "string"
},
"hours" : {
"type" : "integer",
"format" : "int32"
},
"minutes" : {
"type" : "integer",
"format" : "int32"
},
"scheduleName" : {
"type" : "string"
},
"schedule_id" : {
"type" : "string"
},
"schedule_status" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE", "DISABLED" ]
}
}
},
"Domain object for JobsRunStatistics" : {
"type" : "object",
"properties" : {
"data_captured_time" : {
"type" : "string",
"format" : "date-time"
},
"num_class_cis_failed_to_reconcile" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_reconcile" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_Successfully_reconciled" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_successfully_reconciled" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for JobsRunStatistics"
},
"Domain object for LastJobsRunStatistics" : {
"type" : "object",
"properties" : {
"data_captured_time" : {
"type" : "string",
"format" : "date-time"
},
"num_class_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"num_rel_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int64"
},
"num_class_cis_successfully_normalized" : {
"type" : "integer",
"format" : "int64"
},
"num_rel_cis_successfully_normalized" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "Domain object for LastJobsRunStatistics"
},
"Domain object for Merge Attribute Group" : {
"type" : "object",
"properties" : {
"attribute_rule_command" : {
"$ref" : "#/definitions/Domain object for Merge Attribute Rule"
}
}
},
"Domain object for Merge Attribute Rule" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"attribute_rule" : {
"$ref" : "#/definitions/Domain object for Merge Attribute Rule"
}
}
},
"Domain object for Merge Attribute Rule Command" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"attribute_rule" : {
"$ref" : "#/definitions/Domain object for Std Merge Attribute Rule"
}
}
},
"Domain object for Merge Class Rule" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE" ]
},
"precedence_value" : {
"type" : "integer",
"format" : "int32"
},
"defer_if_null" : {
"type" : "boolean"
},
"combine_list" : {
"type" : "boolean"
}
}
},
"Domain object for Merge Class Rule Command" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"class_rule" : {
"$ref" : "#/definitions/Domain object for Merge Class Rule"
}
}
},
"Domain object for Merge Class Rules" : {
"type" : "object",
"properties" : {
"namespace" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"class_rule_command" : {
"$ref" : "#/definitions/Domain object for Merge Class Rule Command"
},
"attribute_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Merge Attribute Group"
}
}
}
},
"Domain object for Merge Dataset Group Association" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"merge_dataset_group_association" : {
"$ref" : "#/definitions/Domain object for Merge Dataset Group Association"
}
}
},
"Domain object for Merge Dataset Group Association Command" : {
"type" : "object",
"properties" : {
"merge_dataset_group_command" : {
"$ref" : "#/definitions/Domain object for Merge Dataset Group Association"
}
}
},
"Domain object for NE Class Configuration" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"attributes" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"mechanisms" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "CATALOG_LOOKUP", "ALIAS_LOOKUP" ]
}
},
"rule_id" : {
"type" : "string"
}
},
"description" : "Domain object for NE Class Configuration, that defines normalization properties for CMDB classes."
},
"Domain object for NE Dataset Configuration" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"dataset_id" : {
"type" : "string"
},
"normalization_type" : {
"type" : "string",
"enum" : [ "CTI", "NAME" ]
},
"normalization_mode" : {
"type" : "string",
"enum" : [ "INLINE", "CONTINUOUS", "OFF" ]
},
"is_unapproved_cis_allowed" : {
"type" : "boolean"
},
"is_new_product_catalog_entry_allowed" : {
"type" : "boolean"
},
"is_trusted" : {
"type" : "boolean"
},
"supported_features" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "INSTANCE", "VERSION_ROLLUP", "SUITE_ROLLUP", "ROW_LEVEL_SECURITY", "RELATIONSHIP", "AUTO_IMPACT", "CUSTOM" ]
}
},
"auto_impact_feature_manual_edit" : {
"type" : "string",
"enum" : [ "APPLY_RULE_ALWAYS", "PRESERVE_MANUAL_EDIT" ]
}
},
"description" : "Domain object for NE Dataset Configuration"
},
"Domain object for NE Job Run Info." : {
"type" : "object",
"properties" : {
"job_definition_id" : {
"type" : "string"
},
"job_run_id" : {
"type" : "string"
},
"job_name" : {
"type" : "string"
},
"job_status" : {
"type" : "string",
"enum" : [ "STARTED", "ABORTED", "STOPPED", "COMPLETED" ]
},
"successful_cis" : {
"type" : "integer",
"format" : "int64"
},
"failed_cis" : {
"type" : "integer",
"format" : "int64"
},
"successful_relationships" : {
"type" : "integer",
"format" : "int64"
},
"failed_relationships" : {
"type" : "integer",
"format" : "int64"
},
"job_runs" : {
"type" : "integer",
"format" : "int64"
},
"current_class_being_processed" : {
"type" : "string"
},
"dataset_id" : {
"type" : "string"
},
"run_end_time" : {
"type" : "string"
},
"log_file_location" : {
"type" : "string"
},
"number_of_cis_in_current_class" : {
"type" : "integer",
"format" : "int64"
},
"number_of_cis_in_current_class_processed" : {
"type" : "integer",
"format" : "int64"
},
"number_of_cis_normalized" : {
"type" : "integer",
"format" : "int64"
},
"number_of_classes_processed" : {
"type" : "integer",
"format" : "int64"
},
"number_of_cis_processed" : {
"type" : "integer",
"format" : "int64"
},
"reason_for_abort" : {
"type" : "string"
},
"run_start_Time" : {
"type" : "string"
},
"total_classes" : {
"type" : "integer",
"format" : "int64"
},
"job_type" : {
"type" : "string",
"enum" : [ "CONTINUOUS_JOB", "BATCH_JOB" ]
},
"job_full_run" : {
"type" : "string",
"enum" : [ "YES", "NO" ]
}
},
"description" : "The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here."
},
"Domain object for NE Job." : {
"type" : "object",
"properties" : {
"jobs_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/NEJob"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "All NE jobs with no runs are contained here."
},
"Domain object for NE Jobs Run History.." : {
"type" : "object",
"properties" : {
"job_runs_history" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for NE Job Run Info."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The job runs of a given job are contained here."
},
"Domain object for NE Jobs Run Info." : {
"type" : "object",
"properties" : {
"last_job_run_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for NE Job Run Info."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The last job runs of all required jobs are contained here."
},
"Domain object for NE NERule" : {
"type" : "object",
"discriminator" : "feature",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"is_enabled" : {
"type" : "boolean"
}
}
},
"Domain object for NE last job run summary" : {
"type" : "object",
"properties" : {
"jobs_run_statistics" : {
"$ref" : "#/definitions/Domain object for LastJobsRunStatistics"
},
"num_jobs_with_runs" : {
"type" : "integer",
"format" : "int64"
},
"num_jobs_with_no_runs" : {
"type" : "integer",
"format" : "int64"
},
"num_inline_dataset" : {
"type" : "integer",
"format" : "int64"
},
"total_jobs" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for NE job run summary"
},
"Domain object for Notification" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"enum" : [ "NOTIFICATION_STATUS_FULL_REFRESH", "NOTIFICATION_STATUS_NORMAL" ]
},
"notification_time" : {
"type" : "string",
"format" : "date-time"
},
"subscription_id" : {
"type" : "string"
},
"source_instance_host" : {
"type" : "string"
},
"created_class_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"updated_class_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"deleted_class_instance_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"created_relationship_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"updated_relationship_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"deleted_relationship_instance_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "Domain object for Notification"
},
"Domain object for PC alias mapping" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"mapping_id" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"discovered_product_name" : {
"type" : "string"
},
"discovered_manufacturer" : {
"type" : "string"
},
"discovered_product_category" : {
"type" : "string"
},
"discovered_product_type" : {
"type" : "string"
},
"discovered_item" : {
"type" : "string"
},
"mapped_product_name" : {
"type" : "string"
},
"mapped_manufacturer" : {
"type" : "string"
},
"mapped_category" : {
"type" : "string"
},
"mapped_type" : {
"type" : "string"
},
"mapped_item" : {
"type" : "string"
},
"product_type" : {
"type" : "string"
},
"ci_type" : {
"type" : "string"
}
},
"description" : "Domain object for NE to PC alias mapping"
},
"Domain object for RE Identification Group Info." : {
"type" : "object",
"properties" : {
"groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Reconciliation Group"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The Identification Group Information for given class are contained here."
},
"Domain object for RE Identification Rule Info." : {
"type" : "object",
"properties" : {
"identification_rules" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Reconciliation Identification Rule"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The Identification Rule Information for given Group are contained here."
},
"Domain object for RE Job Info." : {
"type" : "object",
"properties" : {
"job_name" : {
"type" : "string"
},
"job_id" : {
"type" : "string"
},
"create_date" : {
"type" : "string"
},
"is_continuous" : {
"type" : "boolean"
},
"no_of_schedules" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "All jobs with no runs are contained here."
},
"Domain object for RE Job Run Info." : {
"type" : "object",
"properties" : {
"successfulCIs" : {
"type" : "integer",
"format" : "int64"
},
"job_definition_id" : {
"type" : "string"
},
"job_run_id" : {
"type" : "string"
},
"job_name" : {
"type" : "string"
},
"job_status" : {
"type" : "string",
"enum" : [ "STARTED", "SUCCESS", "FAILED", "CANCELLED", "ABORTED", "QUEUED", "PAUSED", "SGPAUSED" ]
},
"successful_cis" : {
"type" : "integer",
"format" : "int64"
},
"failed_cis" : {
"type" : "integer",
"format" : "int64"
},
"successful_relationships" : {
"type" : "integer",
"format" : "int64"
},
"failed_relationships" : {
"type" : "integer",
"format" : "int64"
},
"total_cis" : {
"type" : "integer",
"format" : "int64"
},
"total_failed_cis" : {
"type" : "integer",
"format" : "int64"
},
"total_processed_cis" : {
"type" : "integer",
"format" : "int64"
},
"job_runs" : {
"type" : "integer",
"format" : "int64"
},
"job_run_activities" : {
"type" : "integer",
"format" : "int64"
},
"event_id" : {
"type" : "string"
},
"dataset_id" : {
"type" : "string"
},
"run_end_time" : {
"type" : "string"
},
"run_start_Time" : {
"type" : "string"
},
"activity_start_time" : {
"type" : "string"
},
"activity_end_time" : {
"type" : "string"
},
"disable_progress_bar" : {
"type" : "boolean"
},
"is_continuous" : {
"type" : "boolean"
},
"activity_name" : {
"type" : "string"
}
},
"description" : "The last Job Run with Successful/Failed CIs/Relationships and no. of Job Runs for a given Job is contained here."
},
"Domain object for RE Job." : {
"type" : "object",
"properties" : {
"jobs_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for RE Job Info."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "All jobs with no runs are contained here."
},
"Domain object for RE Jobs Run Info." : {
"type" : "object",
"properties" : {
"last_job_run_info" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for RE Job Run Info."
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The last job runs of all required jobs are contained here."
},
"Domain object for RE Merge Association Set Info." : {
"type" : "object",
"properties" : {
"merge_association_sets" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Reconciliation Merge Association Set"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
},
"description" : "The list of all Merge Association Set Information are contained here."
},
"Domain object for RE Queued Jobs." : {
"type" : "object",
"properties" : {
"job_name" : {
"type" : "string"
},
"job_id" : {
"type" : "string"
},
"queued_since" : {
"type" : "string"
}
},
"description" : "All information for queued jobs is contained here."
},
"Domain object for RE job run summary" : {
"type" : "object",
"properties" : {
"total_jobs" : {
"type" : "integer",
"format" : "int32"
},
"jobs_run_statistics" : {
"$ref" : "#/definitions/Domain object for JobsRunStatistics"
},
"num_run_jobs" : {
"type" : "integer",
"format" : "int32"
},
"num_jobs_with_no_runs" : {
"type" : "integer",
"format" : "int32"
},
"num_queued_jobs" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for RE job run summary"
},
"Domain object for Reconciliation Group" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "MERGE", "QUALIFICATION", "IDENTIFICATION", "WORKFLOW" ]
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"uses_standard_rules" : {
"type" : "boolean"
}
}
},
"Domain object for Reconciliation Identification Group" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "MERGE", "QUALIFICATION", "IDENTIFICATION", "WORKFLOW" ]
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"uses_standard_rules" : {
"type" : "boolean"
},
"class_name" : {
"type" : "string"
}
}
},
"Domain object for Reconciliation Identification Rule" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"group_id" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"qualification" : {
"type" : "string"
},
"execution_order" : {
"type" : "integer",
"format" : "int32"
},
"find_dataset" : {
"type" : "string"
},
"rules_option" : {
"type" : "string"
}
}
},
"Domain object for Reconciliation Job" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE" ]
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"change_history" : {
"type" : "string"
},
"assigned_to" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"use_standard_rules" : {
"type" : "boolean"
},
"is_continuous" : {
"type" : "boolean"
},
"process_normalized_ci_only" : {
"type" : "boolean"
},
"delete_files_on_exit" : {
"type" : "boolean"
},
"disable_progress_bar" : {
"type" : "boolean"
},
"continuous_job_interval" : {
"type" : "integer",
"format" : "int32"
},
"number_of_job_runs_retained" : {
"type" : "integer",
"format" : "int32"
},
"exclude_orphan_weak_ci" : {
"type" : "boolean"
},
"schedules" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
}
},
"activities" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}
},
"schedule_command" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ScheduleCommand"
}
},
"activity_command" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ActivityCommand"
}
}
}
},
"Domain object for Reconciliation Job Activity" : {
"type" : "object",
"discriminator" : "type",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"sequence" : {
"type" : "integer",
"format" : "int32"
},
"namespace" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE" ]
},
"continue_on_error" : {
"type" : "boolean"
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"qualification_group" : {
"$ref" : "#/definitions/Domain object for Reconciliation Qualification Group Association for a Activity"
}
}
},
"Domain object for Reconciliation Job Events" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"job_run_instance_id" : {
"type" : "string"
},
"run_start_time" : {
"type" : "string"
},
"run_end_time" : {
"type" : "string"
},
"getjobName" : {
"type" : "string"
},
"job_run_status" : {
"type" : "string",
"enum" : [ "STARTED", "SUCCESS", "FAILED", "CANCELLED", "ABORTED", "QUEUED", "PAUSED", "SGPAUSED" ]
},
"number_of_events" : {
"type" : "integer",
"format" : "int32"
},
"job_events" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Reconciliation Job Events"
}
}
}
},
"Domain object for Reconciliation Merge Association Set" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
}
},
"Domain object for Reconciliation Merge Group" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "MERGE", "QUALIFICATION", "IDENTIFICATION", "WORKFLOW" ]
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"uses_standard_rules" : {
"type" : "boolean"
},
"precedence_value" : {
"type" : "integer",
"format" : "int32"
},
"defer_if_null" : {
"type" : "boolean"
},
"combine_list" : {
"type" : "boolean"
},
"explicit_precedence" : {
"type" : "boolean"
},
"class_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Merge Class Rules"
}
}
}
},
"Domain object for Reconciliation Qualification Group" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "MERGE", "QUALIFICATION", "IDENTIFICATION", "WORKFLOW" ]
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"uses_standard_rules" : {
"type" : "boolean"
}
}
},
"Domain object for Reconciliation Qualification Group Association for a Activity" : {
"type" : "object",
"properties" : {
"group_id" : {
"type" : "string"
},
"group_name" : {
"type" : "string"
}
}
},
"Domain object for Reconciliation Qualification Rule" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"group_id" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"created_by" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"created_date" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"status" : {
"type" : "string",
"enum" : [ "ACTIVE", "INACTIVE" ]
},
"qualification" : {
"type" : "string"
}
}
},
"Domain object for Std Merge Attribute Group" : {
"type" : "object",
"properties" : {
"attribute_rule_command" : {
"$ref" : "#/definitions/Domain object for Merge Attribute Rule Command"
}
}
},
"Domain object for Std Merge Attribute Rule" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"attribute_name" : {
"type" : "string"
},
"precedence_value" : {
"type" : "integer",
"format" : "int32"
}
}
},
"Domain object for Std Merge Class Rule" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"precedence_value" : {
"type" : "integer",
"format" : "int32"
}
}
},
"Domain object for Std Merge Class Rule Command" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"class_rule" : {
"$ref" : "#/definitions/Domain object for Std Merge Class Rule"
}
}
},
"Domain object for Std Merge Class Rules" : {
"type" : "object",
"properties" : {
"namespace" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"class_rule_command" : {
"$ref" : "#/definitions/Domain object for Std Merge Class Rule Command"
},
"attribute_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Std Merge Attribute Group"
}
}
}
},
"Domain object for Std Merge Dataset Info" : {
"type" : "object",
"properties" : {
"dataset_rule_command" : {
"$ref" : "#/definitions/Domain object for Std Merge Dataset Rule Command"
}
}
},
"Domain object for Std Merge Dataset Rule" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"dataset_id" : {
"type" : "string"
},
"precedence_value" : {
"type" : "integer",
"format" : "int32"
},
"class_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Std Merge Class Rules"
}
}
}
},
"Domain object for Std Merge Dataset Rule Command" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"dataset_rule" : {
"$ref" : "#/definitions/Domain object for Std Merge Dataset Rule"
}
}
},
"Domain object for Std Merge Rules List" : {
"type" : "object",
"properties" : {
"num_matches" : {
"type" : "integer",
"format" : "int64"
},
"merge_dataset_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Std Merge Dataset Info"
}
}
}
},
"Domain object for Version" : {
"type" : "object",
"properties" : {
"applicationId" : {
"type" : "string"
},
"applicationName" : {
"type" : "string"
},
"majorVer" : {
"type" : "integer",
"format" : "int32"
},
"minorVer" : {
"type" : "integer",
"format" : "int32"
},
"maintenanceVer" : {
"type" : "integer",
"format" : "int32"
},
"patchNum" : {
"type" : "integer",
"format" : "int32"
},
"stage" : {
"type" : "integer",
"format" : "int32"
},
"exist" : {
"type" : "boolean"
}
},
"description" : "VersionInfo Object is contained here."
},
"Domain object for Versions" : {
"type" : "object",
"properties" : {
"applicationVersions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Version"
}
}
},
"description" : "The list of VersionInfo Objects are contained here."
},
"Domain object for attachment set list." : {
"type" : "object",
"properties" : {
"attachment_set_names" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"description" : "Attachment set names"
},
"Domain object for datasource" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"provider_type" : {
"type" : "string",
"enum" : [ "VIA_API", "ATRIUM_INTEGRATOR", "MANUAL", "OTHER" ]
},
"description" : {
"type" : "string"
},
"added_by" : {
"type" : "string"
},
"related_dataset_id" : {
"type" : "string"
},
"other_provider_type_details" : {
"type" : "string"
}
}
},
"Domain object for details of failed CI" : {
"type" : "object",
"properties" : {
"ci_instance_id" : {
"type" : "string"
},
"ci_name" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"ci_class_form_name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"dataset_id" : {
"type" : "string"
}
},
"description" : "Domain object for details of failed CI"
},
"Domain object for failed CIs for given data source" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"failed_cis" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for details of failed CI"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
},
"data_captured_time" : {
"type" : "string"
}
},
"description" : "Domain object for failed CIs for given data source"
},
"Domain object for output of Bulk Operaions." : {
"type" : "object",
"properties" : {
"operation" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE" ]
},
"status" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/StatusInfo"
}
},
"instance_id" : {
"type" : "string"
}
}
},
"Domain object for summary of instances in given datasource" : {
"type" : "object",
"properties" : {
"total_cis" : {
"type" : "integer",
"format" : "int32"
},
"num_processed_cis" : {
"type" : "integer",
"format" : "int32"
},
"num_unprocessed_cis" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_normalize" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_failed_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_identify" : {
"type" : "integer",
"format" : "int32"
},
"num_class_cis_failed_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"num_rel_cis_failed_to_merge" : {
"type" : "integer",
"format" : "int32"
},
"data_captured_time" : {
"type" : "string"
}
}
},
"DsmQueriesScanConfigModel" : {
"type" : "object",
"required" : [ "class_name_key", "instance_id" ],
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"instance_id" : {
"type" : "string"
},
"scan_frequency" : {
"type" : "integer",
"format" : "int32"
},
"scan_frequency_unit" : {
"type" : "string",
"enum" : [ "HOURS", "MINUTES", "DAYS" ]
},
"last_scan_time" : {
"type" : "string",
"format" : "date-time"
}
}
},
"DsmQueriesScanConfigService" : {
"type" : "object"
},
"DsmServiceQueriesService" : {
"type" : "object"
},
"EnumLimit" : {
"type" : "object",
"properties" : {
"regular_items" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"custom_items" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CustomEnumItem"
}
}
}
},
"ExecuteActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"job_id_to_execute" : {
"type" : "string"
}
}
} ]
},
"FeatureProperty" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
},
"is_append" : {
"type" : "boolean"
}
}
},
"FederationClassService" : {
"type" : "object"
},
"FederationManagerService" : {
"type" : "object"
},
"FederationPluginService" : {
"type" : "object"
},
"FederationPluginStatus" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"plugin_id" : {
"type" : "string"
},
"plugin_loaded" : {
"type" : "boolean"
}
}
},
"FederationPluginStatusList" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"federation_plugins_status" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/FederationPluginStatus"
}
}
}
},
"Filter" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"filter_name" : {
"type" : "string"
},
"filter_type" : {
"type" : "string",
"enum" : [ "GLOBAL", "PERSONAL" ]
},
"description" : {
"type" : "string"
},
"show_deleted_item" : {
"type" : "boolean"
},
"selected_relationship_classes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/class_name_key"
}
},
"selected_ci_classes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/class_name_key"
}
}
}
},
"GraphWalkService" : {
"type" : "object"
},
"HalLink" : {
"type" : "object",
"properties" : {
"href" : {
"type" : "string"
}
}
},
"IdentificationActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"generate_ids" : {
"type" : "boolean"
},
"exclude_subclasses" : {
"type" : "boolean"
},
"production_dataset_id" : {
"type" : "string"
},
"dataset_configurations" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ActivityGroupAssociation"
}
}
}
} ]
},
"ImpactService" : {
"type" : "object"
},
"ImpactSimulationResult" : {
"type" : "object",
"properties" : {
"simulation_id" : {
"type" : "string"
},
"status" : {
"type" : "string"
}
}
},
"ImportDatastoreFieldInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"datatype" : {
"type" : "string"
},
"xml_parent_node" : {
"type" : "string"
}
}
},
"ImportFileDatastoreFileInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"xml_parent_nodes" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"ImportJob" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"source_datastore_type" : {
"type" : "string"
},
"source_datastore_id" : {
"type" : "string"
},
"target_ar_datastore_id" : {
"type" : "string"
},
"target_dataset_id" : {
"type" : "string"
},
"carteServer" : {
"type" : "string"
},
"ci_mappings" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CiMapping"
}
},
"relationship_mappings" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RelationshipMapping"
}
},
"schedule_info" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
},
"schedule" : {
"$ref" : "#/definitions/ImportSchedule"
}
}
},
"ImportSchedule" : {
"type" : "object",
"properties" : {
"hour" : {
"type" : "integer",
"format" : "int32"
},
"minute" : {
"type" : "integer",
"format" : "int32"
},
"schedName" : {
"type" : "string"
},
"jobId" : {
"type" : "string"
},
"type" : {
"type" : "integer",
"format" : "int32"
},
"carteServer" : {
"type" : "string"
},
"recurrance" : {
"type" : "string"
},
"status" : {
"type" : "integer",
"format" : "int32"
}
}
},
"InstanceService" : {
"type" : "object"
},
"IntegerLimit" : {
"type" : "object",
"properties" : {
"min_value" : {
"type" : "integer",
"format" : "int32"
},
"max_value" : {
"type" : "integer",
"format" : "int32"
}
}
},
"IntegrityExceptionDetail" : {
"type" : "object",
"properties" : {
"exceptionType" : {
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"name" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"instance_id" : {
"type" : "string"
},
"reconclilation_id" : {
"type" : "string"
},
"exception_since" : {
"type" : "string"
},
"exception_type" : {
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
},
"error_description" : {
"type" : "string"
},
"recommended_action" : {
"type" : "string"
}
}
},
"InternalCallContext" : {
"type" : "object",
"properties" : {
"properties" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/definitions/Serializable"
}
},
"messages" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"$ref" : "#/definitions/StatusInfo"
}
},
"skipPreparedStatement" : {
"type" : "boolean"
},
"runByEscalation" : {
"type" : "boolean"
},
"exportInChunks" : {
"type" : "boolean"
},
"organizationId" : {
"type" : "string"
},
"rxCall" : {
"type" : "boolean"
},
"done" : {
"type" : "boolean"
},
"password" : {
"type" : "string"
},
"progressiveViewSupported" : {
"type" : "boolean"
},
"imsJwtTokenValidated" : {
"type" : "boolean"
},
"assignedOverlayGroup" : {
"type" : "integer",
"format" : "int32"
},
"impersonatedUser" : {
"type" : "string"
},
"restrictOperationsAllowedTags" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"localizationInfo" : {
"$ref" : "#/definitions/LocalizationInfo"
},
"processCorrelationId" : {
"type" : "string"
},
"timeoutInSeconds" : {
"type" : "integer",
"format" : "int32"
},
"overlayGroupMapping" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"clientApiVersion" : {
"type" : "integer",
"format" : "int32"
},
"validateWithAuthToken" : {
"type" : "boolean"
},
"parentProcessInstanceId" : {
"type" : "string"
},
"processInstanceId" : {
"type" : "string"
},
"user" : {
"type" : "string"
},
"clientType" : {
"$ref" : "#/definitions/ClientType"
},
"clientIPAddress" : {
"type" : "string"
},
"customGroupList" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
},
"logMask" : {
"$ref" : "#/definitions/BitSet"
},
"rpcSocketNum" : {
"type" : "integer",
"format" : "int32"
},
"designTime" : {
"type" : "boolean"
},
"logoutRequest" : {
"type" : "boolean"
},
"vuiType" : {
"type" : "string",
"enum" : [ "NONE", "WINDOWS", "WEB", "WEB_ABS_POS", "WIRELESS", "WEB_AUTOGEN", "WEB_ABS_POS_AUTOGEN", "DEFAULT", "SELECT", "PROGRESSIVE" ]
},
"maxResponse" : {
"type" : "integer",
"format" : "int32"
},
"authToken" : {
"type" : "string"
},
"clientGuid" : {
"type" : "string"
},
"authString" : {
"type" : "string"
},
"overlayGroup" : {
"type" : "integer",
"format" : "int32"
},
"accessAllFields" : {
"type" : "boolean"
},
"overlayGroupStr" : {
"type" : "string"
},
"requestId" : {
"type" : "integer",
"format" : "int32"
},
"serviceStatMsg" : {
"type" : "string"
},
"authGuid" : {
"type" : "string"
},
"cacheId" : {
"type" : "integer",
"format" : "int32"
},
"imsJwtToken" : {
"type" : "string"
},
"restUrl" : {
"type" : "string"
},
"allowedOrigin" : {
"type" : "string"
},
"tenantId" : {
"type" : "string"
}
}
},
"IntervalJobSchedule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Job Schedule"
}, {
"type" : "object",
"properties" : {
"interval_in_minutes" : {
"type" : "integer",
"format" : "int32"
}
}
} ]
},
"JobSchedulingService" : {
"type" : "object"
},
"Locale" : {
"type" : "object",
"properties" : {
"language" : {
"type" : "string"
},
"script" : {
"type" : "string"
},
"country" : {
"type" : "string"
},
"variant" : {
"type" : "string"
},
"extensionKeys" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"unicodeLocaleAttributes" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"unicodeLocaleKeys" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
},
"iso3Language" : {
"type" : "string"
},
"iso3Country" : {
"type" : "string"
},
"displayLanguage" : {
"type" : "string"
},
"displayScript" : {
"type" : "string"
},
"displayCountry" : {
"type" : "string"
},
"displayVariant" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
}
}
},
"LocalizationInfo" : {
"type" : "object",
"properties" : {
"locale" : {
"$ref" : "#/definitions/Locale"
},
"timezone" : {
"$ref" : "#/definitions/TimeZone"
},
"charset" : {
"$ref" : "#/definitions/Charset"
},
"customDateFormat" : {
"type" : "string"
},
"customTimeFormat" : {
"type" : "string"
},
"separators" : {
"type" : "string"
}
}
},
"Logger" : {
"type" : "object",
"properties" : {
"debugEnabled" : {
"type" : "boolean"
},
"infoEnabled" : {
"type" : "boolean"
},
"traceEnabled" : {
"type" : "boolean"
},
"logLevel" : {
"type" : "string",
"enum" : [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ]
}
}
},
"MergeActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"merge_order" : {
"type" : "string",
"enum" : [ "BY_CLASS", "RELATED_CIS_TOGETHER", "RELATED_CIS_SEPARATELY" ]
},
"precedence_association_set_id" : {
"type" : "string"
},
"precedence_association_set_name" : {
"type" : "string"
},
"include_unchanged_cis" : {
"type" : "boolean"
},
"target_dataset_id" : {
"type" : "string"
},
"source_dataset_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
} ]
},
"MergeDatasetGroupInfoList" : {
"type" : "object",
"properties" : {
"num_matches" : {
"type" : "integer",
"format" : "int64"
},
"merge_dataset_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Merge Dataset Group Association Command"
}
}
}
},
"MonthlyJobSchedule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Job Schedule"
}, {
"type" : "object",
"properties" : {
"days_of_month" : {
"type" : "array",
"items" : {
"type" : "integer",
"format" : "int32"
}
}
}
} ]
},
"NECancelJobCommand" : {
"type" : "object",
"properties" : {
"neJobService" : {
"$ref" : "#/definitions/NEJobService"
},
"logger" : {
"$ref" : "#/definitions/Logger"
}
}
},
"NEJob" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"dataset_id" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "CONTINUOUS_JOB", "BATCH_JOB" ]
},
"job_schedule" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
},
"created_date" : {
"type" : "string"
},
"created_by" : {
"type" : "string"
},
"modified_date" : {
"type" : "string"
},
"modified_by" : {
"type" : "string"
},
"schedulestring" : {
"type" : "string"
},
"job_schedule_type" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
},
"is_auto_start" : {
"type" : "boolean"
}
}
},
"NEJobService" : {
"type" : "object"
},
"NERuleService" : {
"type" : "object"
},
"NEStartJobCommand" : {
"type" : "object",
"properties" : {
"neJobService" : {
"$ref" : "#/definitions/NEJobService"
},
"logger" : {
"$ref" : "#/definitions/Logger"
}
}
},
"NEUtilityService" : {
"type" : "object"
},
"NOEService" : {
"type" : "object"
},
"NOESubscribeCommand" : {
"type" : "object",
"properties" : {
"logger" : {
"$ref" : "#/definitions/Logger"
},
"noeService" : {
"$ref" : "#/definitions/NOEService"
}
}
},
"NOEUnSubscribeCommand" : {
"type" : "object",
"properties" : {
"logger" : {
"$ref" : "#/definitions/Logger"
},
"noeService" : {
"$ref" : "#/definitions/NOEService"
}
}
},
"Node" : {
"type" : "object",
"required" : [ "key", "value" ],
"properties" : {
"key" : {
"type" : "string"
},
"value" : {
"type" : "object"
},
"form" : {
"type" : "string"
}
}
},
"OnceJobSchedule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Job Schedule"
}, {
"type" : "object"
} ]
},
"PCComponent" : {
"type" : "object",
"properties" : {
"suite_instance_id" : {
"type" : "string"
},
"suite_id" : {
"type" : "string"
},
"product_id" : {
"type" : "string"
},
"product_instance_id" : {
"type" : "string"
},
"version_instance_id" : {
"type" : "string"
},
"model_version" : {
"type" : "string"
},
"product_name" : {
"type" : "string"
},
"manufacturer" : {
"type" : "string"
},
"market_version" : {
"type" : "string"
},
"is_suite_definition" : {
"type" : "boolean"
},
"suite_tier_1" : {
"type" : "string"
},
"suite_tier_2" : {
"type" : "string"
},
"suite_tier_3" : {
"type" : "string"
}
}
},
"PropagatedAttributeInfo" : {
"type" : "object",
"properties" : {
"source_attribute_name" : {
"type" : "string"
},
"source_attribute_id" : {
"type" : "string"
},
"destination_attribute_name" : {
"type" : "string"
},
"destination_attribute_id" : {
"type" : "string"
},
"source_attribute_classname" : {
"type" : "string"
},
"destination_attribute_classname" : {
"type" : "string"
}
}
},
"PurgeActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"verify_in_target_dataset" : {
"type" : "boolean"
},
"purge_instances" : {
"type" : "string",
"enum" : [ "IDENTIFIED_AND_UNIDENTIFIED", "IDENTIFIED", "UNIDENTIFIED" ]
},
"target_dataset_id" : {
"type" : "string"
},
"source_dataset_ids" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
} ]
},
"QueryByPathService" : {
"type" : "object"
},
"RECancelJobCommand" : {
"type" : "object",
"properties" : {
"reJobsService" : {
"$ref" : "#/definitions/REJobService"
},
"logger" : {
"$ref" : "#/definitions/Logger"
}
}
},
"REJobService" : {
"type" : "object"
},
"REStartJobCommand" : {
"type" : "object",
"properties" : {
"reJobsService" : {
"$ref" : "#/definitions/REJobService"
},
"logger" : {
"$ref" : "#/definitions/Logger"
}
}
},
"RealLimit" : {
"type" : "object",
"properties" : {
"precision" : {
"type" : "integer",
"format" : "int32"
},
"min_value" : {
"type" : "number",
"format" : "double"
},
"max_value" : {
"type" : "number",
"format" : "double"
}
}
},
"RelEndpointInfo" : {
"type" : "object",
"properties" : {
"role_name" : {
"type" : "string",
"readOnly" : true
},
"class_name_key" : {
"readOnly" : true,
"$ref" : "#/definitions/class_name_key"
},
"class_id" : {
"type" : "string",
"readOnly" : true
}
}
},
"RelationshipMapping" : {
"type" : "object",
"properties" : {
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"logical_name" : {
"type" : "string"
},
"parent_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"parent_logical_name" : {
"type" : "string"
},
"child_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"child_logical_name" : {
"type" : "string"
},
"attributes" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/RelationshipMappingEntry"
}
},
"schema_name" : {
"type" : "string"
},
"table_name" : {
"type" : "string"
},
"file_name" : {
"type" : "string"
},
"getxPath" : {
"type" : "string"
},
"delta_column" : {
"type" : "string"
},
"update_source_column" : {
"type" : "string"
}
}
},
"RelationshipMappingEntry" : {
"type" : "object",
"properties" : {
"source" : {
"type" : "string"
},
"target" : {
"type" : "string"
},
"datatype" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"ci_name" : {
"type" : "string"
}
}
},
"RelationshipRule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for NE NERule"
}, {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"source_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"destination_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"is_class_applies_to_children" : {
"type" : "boolean"
},
"is_source_class_applies_to_children" : {
"type" : "boolean"
},
"is_destination_class_applies_to_children" : {
"type" : "boolean"
},
"qualification" : {
"type" : "string"
},
"source_qualification" : {
"type" : "string"
},
"destination_qualification" : {
"type" : "string"
},
"name_feature_property" : {
"type" : "string"
}
}
} ]
},
"RenameActivity" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Reconciliation Job Activity"
}, {
"type" : "object",
"properties" : {
"dataset_id_to_rename" : {
"type" : "string"
},
"new_dataset_id" : {
"type" : "string"
}
}
} ]
},
"RequestChangedCIsCommand" : {
"type" : "object",
"properties" : {
"logger" : {
"$ref" : "#/definitions/Logger"
},
"noeService" : {
"$ref" : "#/definitions/NOEService"
}
}
},
"RowLevelSecurityRule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for NE NERule"
}, {
"type" : "object",
"properties" : {
"precedence" : {
"type" : "integer",
"format" : "int32"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"source_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"destination_class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"is_class_applies_to_children" : {
"type" : "boolean"
},
"is_source_class_applies_to_children" : {
"type" : "boolean"
},
"is_destination_class_applies_to_children" : {
"type" : "boolean"
},
"qualification" : {
"type" : "string"
},
"source_qualification" : {
"type" : "string"
},
"destination_qualification" : {
"type" : "string"
},
"cmdb_row_level_security" : {
"type" : "string"
},
"cmdb_write_security" : {
"type" : "string"
}
}
} ]
},
"RunArchiveCommand" : {
"type" : "object",
"properties" : {
"logger" : {
"$ref" : "#/definitions/Logger"
},
"classService" : {
"$ref" : "#/definitions/ClassService"
}
}
},
"ScheduleCommand" : {
"type" : "object",
"properties" : {
"operation_type" : {
"type" : "string",
"enum" : [ "POST", "PATCH", "DELETE", "GET" ]
},
"schedule" : {
"$ref" : "#/definitions/Domain object for Job Schedule"
}
}
},
"Serializable" : {
"type" : "object"
},
"StatusInfo" : {
"type" : "object",
"properties" : {
"messageCatalog" : {
"type" : "string"
},
"messageNum" : {
"type" : "integer",
"format" : "int32"
},
"appendedText" : {
"type" : "string"
},
"messageType" : {
"type" : "integer",
"format" : "int32"
},
"messageText" : {
"type" : "string"
}
}
},
"StdIdentificationRule" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string"
},
"name_space" : {
"type" : "string"
},
"class_name" : {
"type" : "string"
},
"priority" : {
"type" : "integer",
"format" : "int32"
},
"attribute_name" : {
"type" : "string"
}
}
},
"StdIdentificationRuleList" : {
"type" : "object",
"properties" : {
"standard_identification_rules" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/StdIdentificationRule"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int64"
}
}
},
"SuiteComponent" : {
"type" : "object",
"properties" : {
"qualification" : {
"type" : "string"
},
"product_rule_id" : {
"type" : "string"
},
"is_required" : {
"type" : "boolean"
}
}
},
"SuiteRollupRule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for NE NERule"
}, {
"type" : "object",
"properties" : {
"suite_instance_id" : {
"type" : "string"
},
"suite_name" : {
"type" : "string"
},
"suite_manufacturer" : {
"type" : "string"
},
"suite_market_version" : {
"type" : "string"
},
"suite_model_version" : {
"type" : "string"
},
"suite_tier_1" : {
"type" : "string"
},
"suite_tier_2" : {
"type" : "string"
},
"suite_tier_3" : {
"type" : "string"
},
"suite_id" : {
"type" : "string"
},
"product_id" : {
"type" : "string"
},
"product_instance_id" : {
"type" : "string"
},
"component_product_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/PCComponent"
}
},
"suite_rule" : {
"$ref" : "#/definitions/SuiteRule"
}
}
} ]
},
"SuiteRule" : {
"type" : "object",
"properties" : {
"precedence" : {
"type" : "integer",
"format" : "int32"
},
"vendor" : {
"type" : "string"
},
"product_name" : {
"type" : "string"
},
"suite_id" : {
"type" : "string"
},
"include_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SuiteComponent"
}
},
"exclude_list" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/SuiteComponent"
}
},
"suite_rule_action" : {
"type" : "string"
},
"rule_id" : {
"type" : "string"
}
}
},
"TimeLimit" : {
"type" : "object"
},
"TimeOfDayLimit" : {
"type" : "object"
},
"TimeZone" : {
"type" : "object",
"properties" : {
"dstsavings" : {
"type" : "integer",
"format" : "int32"
},
"rawOffset" : {
"type" : "integer",
"format" : "int32"
},
"id" : {
"type" : "string"
},
"displayName" : {
"type" : "string"
}
}
},
"TransRunInfo" : {
"type" : "object",
"properties" : {
"trans_id" : {
"type" : "string"
},
"trans_name" : {
"type" : "string"
},
"carte_server_instanceid" : {
"type" : "string"
},
"trans_start_date" : {
"type" : "string"
},
"trans_end_date" : {
"type" : "string"
},
"records_input" : {
"type" : "integer",
"format" : "int64"
},
"records_added" : {
"type" : "integer",
"format" : "int64"
},
"records_rejected" : {
"type" : "integer",
"format" : "int64"
},
"records_updated" : {
"type" : "integer",
"format" : "int64"
},
"records_written" : {
"type" : "integer",
"format" : "int64"
},
"errors" : {
"type" : "integer",
"format" : "int64"
}
}
},
"UDMService" : {
"type" : "object"
},
"UIComponentService" : {
"type" : "object"
},
"UserService" : {
"type" : "object"
},
"VersionRollupRule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for NE NERule"
}, {
"type" : "object",
"properties" : {
"precedence" : {
"type" : "integer",
"format" : "int32"
},
"id" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"manufacturer_name" : {
"type" : "string"
},
"product_name" : {
"type" : "string"
},
"class_name_key" : {
"$ref" : "#/definitions/class_name_key"
},
"qualification" : {
"type" : "string"
},
"market_version" : {
"type" : "string"
}
}
} ]
},
"VersionService" : {
"type" : "object"
},
"WeeklyJobSchedule" : {
"allOf" : [ {
"$ref" : "#/definitions/Domain object for Job Schedule"
}, {
"type" : "object",
"properties" : {
"days_of_week" : {
"type" : "array",
"items" : {
"type" : "string",
"enum" : [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ]
}
}
}
} ]
},
"agregate_info" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"integrity_percent" : {
"type" : "string"
},
"completeness_percent" : {
"type" : "string"
},
"health_percent" : {
"type" : "string"
},
"integrity_exception_count" : {
"type" : "string"
},
"orphan_exception_count" : {
"type" : "string"
},
"duplicate_exception_count" : {
"type" : "string"
},
"completeness_exception_count" : {
"type" : "string"
},
"total_ci_count" : {
"type" : "string"
},
"last_data_refresh_time" : {
"type" : "string",
"format" : "date-time"
},
"utility_status" : {
"type" : "string"
},
"excluded_classes_orphan" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Excluded Classes Info"
}
},
"excluded_classes_duplicate" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Excluded Classes Info"
}
},
"excluded_classes_completeness" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Excluded Classes Info"
}
},
"excluded_classes_datasources" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Excluded Classes Info"
}
}
}
},
"ci_update_details" : {
"type" : "object",
"properties" : {
"ci_update_details" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for CIUpdates detail"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "Domain object for CIUpdates detail list"
},
"class_name_key" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"namespace" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
}
}
},
"completeness_exception_details" : {
"type" : "object",
"properties" : {
"completenessExceptionDetailList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/CompletenessExceptionDetail"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "The list of incomplete CI exception details Objects are contained here."
},
"dashboard_schedule_list" : {
"type" : "object",
"properties" : {
"dashboardScheduleList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/DashboardSchedule"
}
}
},
"description" : "The list of Dashboard Schedule Objects are contained here."
},
"dataset_configs" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"dataset_configs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for NE Dataset Configuration"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "This contains the list of NEDatasetConfig Objects with numMatches"
},
"federated_groups" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"federated_groups" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for BMC_FederatedProduct"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "This contains the list of FederatedGroup Objects."
},
"federation_plugins" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"federation_plugins" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for FederationPluginConfig"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "This contains the list of FederationPluginConfig Objects."
},
"health_exception" : {
"type" : "object",
"properties" : {
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"exception_type" : {
"type" : "string"
},
"exception_subtype" : {
"type" : "string",
"enum" : [ "ORPHAN", "DUPLICATE" ]
},
"exception_count" : {
"type" : "integer",
"format" : "int32"
}
}
},
"health_exceptions" : {
"type" : "object",
"properties" : {
"healthExceptionList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/health_exception"
}
}
},
"description" : "The list of Instance Objects are contained here."
},
"instances" : {
"type" : "object",
"properties" : {
"instances" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for Instance"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "The list of Instance Objects are contained here."
},
"integrity_exception_details" : {
"type" : "object",
"properties" : {
"integrityExceptionDetailList" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/IntegrityExceptionDetail"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
},
"description" : "The list of integrity exception details are contained here."
},
"menus" : {
"type" : "object",
"properties" : {
"menus" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
}
},
"ne_class_configs" : {
"type" : "object",
"properties" : {
"ne_class_configs" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for NE Class Configuration"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
}
},
"pc_alias_mappings" : {
"type" : "object",
"properties" : {
"pc_alias_mappings" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Domain object for PC alias mapping"
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
}
},
"permission" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"id" : {
"type" : "string"
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
}
}
},
"permissions" : {
"type" : "object",
"properties" : {
"permissions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/permission"
}
},
"_links" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/HalLink"
}
}
},
"num_matches" : {
"type" : "integer",
"format" : "int32"
}
}
}
}
}