{ "swagger":"2.0", "info":{ "description":"New Application Management REST endpoints", "version":"2019.09.03", "title":"REST API for Application Mangement 12c", "x-summary":"New Application Management REST endpoints" }, "basePath":"/iam/governance/applicationmanagement", "tags":[ { "name":"Applications" }, { "name":"General", "description":"This category contains all the operations that did not fit in a more specific category." }, { "name":"Jobs" }, { "name":"Templates" }, { "name":"Upgrade" } ], "paths":{ "/api/v1/applications":{ "get":{ "tags":[ "Applications" ], "summary":"Finds applications by appname,type,status", "description":"Find applications by providing app name, type, status as URL params. Sorting and pagination supported", "operationId":"searchApplicationsWithQueryParams", "produces":[ "application/json" ], "parameters":[ { "name":"name", "in":"query", "description":"Application name that need to be searched", "required":false, "type":"string" }, { "name":"disconnected", "in":"query", "description":"Application disconnected or not. Pass true if disconnected false if connected", "required":false, "type":"string" }, { "name":"displayName", "in":"query", "description":"Application display name that need to be searched", "required":false, "type":"string" }, { "name":"connectorName", "in":"query", "description":"Connector name that need to be searched", "required":false, "type":"string" }, { "name":"baseappName", "in":"query", "description":"Base Application name that need to be searched", "required":false, "type":"string" }, { "name":"authoritative", "in":"query", "description":" Application authoritative or target. Pass true if authoritative, false otherwise", "required":false, "type":"string" }, { "name":"attributes", "in":"query", "description":"Application attributes that need to be returned", "required":false, "type":"string" }, { "name":"startindex", "in":"query", "description":"Pagination startindex from which results need to be returned", "required":false, "type":"integer", "format":"int32" }, { "name":"count", "in":"query", "description":"No of Applications to be returned from startindex", "required":false, "type":"integer", "format":"int32" }, { "name":"sortby", "in":"query", "description":"Attribute on which sorting needs to be done", "required":false, "type":"string" }, { "name":"sortorder", "in":"query", "description":"Sort Order default Descending", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Application" } } } }, "x-internal-id":"api-v1-applications-get", "x-filename-id":"api-v1-applications-get" }, "post":{ "tags":[ "Applications" ], "summary":"Creates a new Application", "description":"Create a new Application in OIM", "operationId":"createApplication", "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Application details for new application to be created", "required":false, "schema":{ "$ref":"#/definitions/Application" } } ], "responses":{ "default":{ "description":"successful operation" } }, "x-internal-id":"api-v1-applications-post", "x-filename-id":"api-v1-applications-post" }, "put":{ "tags":[ "Applications" ], "summary":"Updates an Application", "description":"Updates existing Application in OIM", "operationId":"updateApplication", "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Application details for application to be updated", "required":false, "schema":{ "$ref":"#/definitions/Application" } } ], "responses":{ "default":{ "description":"successful operation" } }, "x-internal-id":"api-v1-applications-put", "x-filename-id":"api-v1-applications-put" } }, "/api/v1/applications/connection":{ "post":{ "tags":[ "Applications" ], "summary":"Create Connection to a target", "description":"Test Connectivity Details for a target system in Application", "operationId":"testConnection", "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Application details with connectivity details to be tested for", "required":false, "schema":{ "$ref":"#/definitions/Application" } } ], "responses":{ "default":{ "description":"successful operation" } }, "x-internal-id":"api-v1-applications-connection-post", "x-filename-id":"api-v1-applications-connection-post" } }, "/api/v1/applications/connectors":{ "get":{ "tags":[ "Applications" ], "summary":"Get available connectors in a given directory", "description":"Lists connector packages present in a given directory. Gives list of connectors from default directory, if no directory given", "operationId":"listAvailableConnectorsinalternatepath", "produces":[ "application/json" ], "parameters":[ { "name":"directory", "in":"query", "description":"Connector Package directory path", "required":false, "type":"string" }, { "name":"authoritative", "in":"query", "description":"Set 'true' for Authoritative list of Connectors", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/CIBean" } } } }, "x-internal-id":"api-v1-applications-connectors-get", "x-filename-id":"api-v1-applications-connectors-get" } }, "/api/v1/applications/connectors/bundletemplate":{ "get":{ "tags":[ "Applications" ], "summary":"Get template in a given connector", "description":"Provides template in a given connector package at given connector directory. Default directory taken if no directory given", "operationId":"getTemplateAtGivenDir", "produces":[ "application/json" ], "parameters":[ { "name":"connectorname", "in":"query", "description":"Connector Name", "required":false, "type":"string" }, { "name":"connectorversion", "in":"query", "description":"Connector Version", "required":false, "type":"string" }, { "name":"connectorpckgdir", "in":"query", "description":"Connector package directory. Default directory taken if left empty", "required":false, "type":"string" }, { "name":"authoritative", "in":"query", "description":"Set 'true' to load template for Authoritative source", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/Application" } } }, "x-internal-id":"api-v1-applications-connectors-bundletemplate-get", "x-filename-id":"api-v1-applications-connectors-bundletemplate-get" } }, "/api/v1/applications/connectorservers":{ "get":{ "tags":[ "Applications" ], "summary":"Get the names of all the Connector Servers", "description":"Get the list of names of all the Connector Servers", "operationId":"getConnectorServers", "produces":[ "application/json" ], "parameters":[ ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/JaxbList" } } }, "x-internal-id":"api-v1-applications-connectorservers-get", "x-filename-id":"api-v1-applications-connectorservers-get" } }, "/api/v1/applications/groovyscriptstatus":{ "post":{ "tags":[ "Applications" ], "summary":"Create compilation status for groovy script", "description":"Test groovy script validity", "operationId":"compileScript", "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Groovy Script", "required":false, "schema":{ "type":"string" } } ], "responses":{ "default":{ "description":"successful operation" } }, "x-internal-id":"api-v1-applications-groovyscriptstatus-post", "x-filename-id":"api-v1-applications-groovyscriptstatus-post" } }, "/api/v1/applications/metadata":{ "put":{ "tags":[ "Applications" ], "summary":"Generates metadata for application configuration", "description":"reconSituations - List of Reconciliation Situations. reconResponses - List of Reconciliation Responses. reconJobModes - List of Job Modes. jobParamDataTypes - List of support data types for Job's parameters. EntitlementTypeJobReqParams - List of Required Parameters for Entitlement Mode type Reconciliation Job. DeleteTypeJobReqParams - List of Required Parameters for Delete Mode type Reconciliation Job. IncrementalTypeJobReqParams - List of Required Parameters for Incremental Mode type Reconciliation Job. fullTypeJobReqParams - List of Required Parameters for Full Mode type Reconciliation Job. ruleElementOperator - List of Rule Element Operator related to Reconciliation Corelation Rule. ruleOperator - List of rule operator related to Reconciliation Corelation Rule. catalogRiskLevelCodeDecodeValueSet - List of catalog Risk Levels. advanceFlags - Writeback, Lookup, Date values for a schema attribute", "operationId":"getApplicationUIMetadata", "parameters":[ ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ApplicationUIMetadata" } } }, "x-internal-id":"api-v1-applications-metadata-put", "x-filename-id":"api-v1-applications-metadata-put" } }, "/api/v1/applications/supportedSchemaAttributes":{ "post":{ "tags":[ "Applications" ], "summary":"Discover supported schema attributes", "description":"List supported schema attributes of target system/Application ", "operationId":"getSupportedSchemaAttributes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Application details with connectivity details to be tested for", "required":false, "schema":{ "$ref":"#/definitions/Application" } }, { "name":"objectClassName", "in":"query", "description":"ObjectClass Name ", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/SchemaAttribute" } } } }, "x-internal-id":"api-v1-applications-supportedSchemaAttributes-post", "x-filename-id":"api-v1-applications-supportedschemaattributes-post" } }, "/api/v1/applications/{appid}":{ "get":{ "tags":[ "Applications" ], "summary":"Gets application details by name", "description":"Get application details by name", "operationId":"getApplicationDetails", "produces":[ "application/json" ], "parameters":[ { "name":"appid", "in":"path", "description":"Application name whose details need to be found", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Application" } } }, "x-internal-id":"api-v1-applications-{appid}-get", "x-filename-id":"api-v1-applications-appid-get" } }, "/api/v1/applications/populateSchemaAttributes":{ "post":{ "tags":[ "Applications" ], "summary":"Discover Target Schema Attributes", "description":"Discover the target schema attributes for an application.", "operationId":"populateschemaattributes", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"app", "description":"Details of the application for which schema needs to be discovered", "required":false, "schema":{ "$ref":"#/definitions/Application" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Application" } } }, "x-internal-id":"api-v1-applications-populateSchemaAttributes-post", "x-filename-id":"api-v1-applications-populateschemaattributes-post" } }, "/api/v1/applications/headers":{ "post":{ "tags":[ "Applications" ], "summary":"Discover Header Fields", "description":"Discover the header fields in Flat File.", "operationId":"getHeaders", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"app", "description":"Details of the application for which header fields need to be discovered", "required":false, "schema":{ "$ref":"#/definitions/Application" } }, { "in":"query", "name":"filelocation", "description":"Location of flat file from which headers have to be discovered", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/JaxbList" } } }, "x-internal-id":"api-v1-applications-headers-post", "x-filename-id":"api-v1-applications-headers-post" } }, "/api/v1/applications/{baseappname}/configurations":{ "get":{ "tags":[ "Applications" ], "summary":"Returns All the Flat File Configurations for a Connected Application", "description":"Gives the list of all the flatfile configurations for a selected connected application.", "operationId":"getConfigurations", "produces":[ "application/json" ], "parameters":[ { "name":"baseappname", "in":"path", "description":"Name of the application for which the flatfile configurations have to be searched.", "required":true, "type":"string" }, { "name":"name", "in":"query", "description":"Name of configuration", "required":false, "type":"string" }, { "name":"displayName", "in":"query", "description":"Display name of configuration", "required":false, "type":"string" }, { "name":"retattrs", "in":"query", "description":"Returned configuration attributes", "required":false, "type":"string" }, { "name":"startIndex", "in":"query", "description":"Start Index of pagination", "required":false, "type":"integer", "format":"int32" }, { "name":"count", "in":"query", "description":"No of configurations to be returned", "required":false, "type":"string", "format":"int32" }, { "name":"sortBy", "in":"query", "description":"Sorted By field. Default is name.", "required":false, "type":"string" }, { "name":"sortOrder", "in":"query", "description":"Sort Order . Default is Descending", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Application" } } }, "x-internal-id":"api-v1-applications-{baseappname}-configurations-get", "x-filename-id":"api-v1-applications-baseappname-configurations-get" } }, "/api/v1/templates":{ "get":{ "tags":[ "Templates" ], "summary":"Search Templates", "description":"Returns the template details.", "operationId":"findTemplates", "produces":[ "application/json" ], "parameters":[ { "name":"name", "in":"query", "description":"Template name that needs to be searched.", "required":false, "type":"string" }, { "name":"isAuth", "in":"query", "description":"Authoritative type template that needs to be searched.", "required":false, "type":"string" }, { "name":"isDisconnected", "in":"query", "description":"Disconnected type template that needs to be searched.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful ", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/Application" } } } }, "x-internal-id":"api-v1-templates-get", "x-filename-id":"api-v1-templates-get" }, "post":{ "tags":[ "Templates" ], "summary":"Create Template", "description":"Creates a new Template in Oracle Idenity Manager.", "operationId":"createTemplate", "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Details of the new template.", "required":false, "schema":{ "$ref":"#/definitions/Application" } } ], "responses":{ "default":{ "description":"Successful " } }, "x-internal-id":"api-v1-templates-post", "x-filename-id":"api-v1-templates-post" }, "put":{ "tags":[ "Templates" ], "summary":"Update Template", "description":"Updates an existing Template in Oracle Idenity Manager.", "operationId":"updateTemplate", "consumes":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Details of the template that needs to be updated.", "required":false, "schema":{ "$ref":"#/definitions/Application" } } ], "responses":{ "default":{ "description":"Successful " } }, "x-internal-id":"api-v1-templates-put", "x-filename-id":"api-v1-templates-put" } }, "/api/v1/templates/{templateid}":{ "get":{ "tags":[ "Templates" ], "summary":"Get template details", "description":"Returns the details of the template, such as name, status, and so on.", "operationId":"getTemplateDetails", "produces":[ "application/json" ], "parameters":[ { "name":"templateid", "in":"path", "description":"Name of thetemplate that needs to be searched.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful ", "schema":{ "$ref":"#/definitions/Application" } } }, "x-internal-id":"api-v1-templates-{templateid}-get", "x-filename-id":"api-v1-templates-templateid-get" } }, "/api/v1/applications/{appId}/jobs":{ "get":{ "tags":[ "Jobs" ], "summary":"Gets the List of All Recon Jobs", "description":"Returns all the recon jobs for a given application.", "operationId":"getAllJobsForApplication", "produces":[ "application/json" ], "parameters":[ { "name":"appId", "in":"path", "description":"Name of the application", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful ", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobDetail" } } } }, "x-internal-id":"api-v1-applications-{appId}-jobs-get", "x-filename-id":"api-v1-applications-appid-jobs-get" }, "post":{ "tags":[ "Jobs" ], "summary":"Adds a New Job", "description":"Adds a new job to an existing Application.", "operationId":"addJob", "consumes":[ "application/json" ], "parameters":[ { "in":"path", "name":"appId", "description":"Name of the application", "required":true, "type":"string" }, { "in":"body", "name":"applicationJobDetails", "description":"Job details of the new job which have to be added to the application.", "required":false, "schema":{ "$ref":"#/definitions/ApplicationJobDetails" } } ], "responses":{ "default":{ "description":"Successful operation" } }, "x-internal-id":"api-v1-applications-{appId}-jobs-post", "x-filename-id":"api-v1-applications-appid-jobs-post" } }, "/api/v1/applications/{appId}/jobs/{jobid}":{ "get":{ "tags":[ "Jobs" ], "summary":"Get the Details of a Particular Job for an application ", "description":"Returns the job details for a given application and job name", "operationId":"getDetailsOfJob", "produces":[ "application/json" ], "parameters":[ { "name":"appId", "in":"path", "description":"Name of the application", "required":true, "type":"string" }, { "name":"jobid", "in":"path", "description":"Name of the Job", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful ", "schema":{ "$ref":"#/definitions/ApplicationJobDetails" } } }, "x-internal-id":"api-v1-applications-{appId}-jobs-{jobid}-get", "x-filename-id":"api-v1-applications-appid-jobs-jobid-get" }, "put":{ "tags":[ "Jobs" ], "summary":"Updates the Job of an Application", "description":"Updates a particular job of a given application.", "operationId":"updateJob", "consumes":[ "application/json" ], "parameters":[ { "in":"path", "name":"appId", "description":"Name of the application", "required":true, "type":"string" }, { "in":"path", "name":"jobid", "description":"Name of the job", "required":true, "type":"string" }, { "in":"body", "name":"job", "description":"Details of the updated job.", "required":false, "schema":{ "$ref":"#/definitions/ApplicationJobDetails" } }, { "in":"query", "name":"operation", "description":"operations : enable/disable/run/stop/update supported on the job", "required":false, "type":"string" } ], "responses":{ "default":{ "description":"Successful " } }, "x-internal-id":"api-v1-applications-{appId}-jobs-{jobid}-put", "x-filename-id":"api-v1-applications-appid-jobs-jobid-put" }, "delete":{ "tags":[ "Jobs" ], "summary":"Delete the Job of an Application", "description":"Deletes a particular Job of a given application.", "operationId":"deleteApplicationJob", "produces":[ "application/json" ], "parameters":[ { "in":"path", "name":"appId", "description":"Name of the application", "required":true, "type":"string" }, { "in":"path", "name":"jobid", "description":"Name of the job", "required":true, "type":"string" } ], "responses":{ "default":{ "description":"Successful " } }, "x-internal-id":"api-v1-applications-{appId}-jobs-{jobid}-delete", "x-filename-id":"api-v1-applications-appid-jobs-jobid-delete" } }, "/api/v1/applications/{appid}/jobs/{jobid}/history":{ "get":{ "tags":[ "Jobs" ], "summary":"Gets All the Execution History Details of a Job", "description":"Returns the complete job history of a given job.", "operationId":"getHistoryOfJob", "produces":[ "application/json" ], "parameters":[ { "in":"path", "name":"appid", "description":"Name of the application", "required":true, "type":"string" }, { "name":"jobid", "in":"path", "description":"Name of the Job", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ApplicationJobHistory" } } } }, "x-internal-id":"api-v1-applications-{appid}-jobs-{jobid}-history-get", "x-filename-id":"api-v1-applications-appid-jobs-jobid-history-get" } }, "/api/v1/applications/{appid}/jobs/{jobid}/history/{historyId}":{ "get":{ "tags":[ "Jobs" ], "summary":"Get the Details of a Specific Job Run", "description":"Returns a specific job run status of a given job.", "operationId":"getResultsOfJob", "produces":[ "application/json" ], "parameters":[ { "in":"path", "name":"appid", "description":"Name of the application", "required":true, "type":"string" }, { "name":"jobid", "in":"path", "description":"Name of the Job", "required":true, "type":"string" }, { "in":"path", "name":"historyId", "description":"historyId of the job", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ApplicationJobResult" } } } }, "x-internal-id":"api-v1-applications-{appid}-jobs-{jobid}-history-{historyId}-get", "x-filename-id":"api-v1-applications-appid-jobs-jobid-history-historyid-get" } }, "/api/v1/applications/{appid}/jobs/{jobid}/history/{historyId}/report":{ "get":{ "tags":[ "Jobs" ], "summary":"Gets the Report of a Job History", "description":"Gets the report of a job run in terms of number of successful events, ussuccessful events, accounts or user created, accounts or users updated, etc ", "operationId":"getReportOfJob", "produces":[ "application/json" ], "parameters":[ { "in":"path", "name":"appid", "description":"Name of the application", "required":true, "type":"string" }, { "name":"jobid", "in":"path", "description":"Name of the Job", "required":true, "type":"string" }, { "in":"path", "name":"historyId", "description":"historyId of the job", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ApplicationJobReport" } } }, "x-internal-id":"api-v1-applications-{appid}-jobs-{jobid}-history-{historyId}-report-get", "x-filename-id":"api-v1-applications-appid-jobs-jobid-history-historyid-report-get" } }, "/api/v1/applications/upgrade/getAvailableUpgrades":{ "get":{ "tags":[ "Upgrade" ], "summary":"Gets the List of all the Connectors available for upgrade", "description":"The new connector bundle should be present in Connector Default Directory.", "operationId":"getavailableupgrades", "produces":[ "application/json" ], "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/JaxbList" } } }, "x-internal-id":"api-v1-applications-upgrade-getAvailableUpgrades-get", "x-filename-id":"api-v1-applications-upgrade-getavailableupgrades-get" } }, "/api/v1/applications/upgrade/diff":{ "get":{ "tags":[ "Upgrade" ], "summary":"Returns the delta between templates", "description":"It returns the difference between the new Connector Template and the already installed Connector Template.Both Target and Authoritative template differences are listed.", "operationId":"findDiff", "produces":[ "application/json" ], "parameters":[ { "name":"connectorDisplayName", "in":"query", "description":"name of the connector", "required":false, "type":"string" }, { "name":"connectorVersion", "in":"query", "description":"latest connector version on which to upgrade", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ApplicationDiff" } } } }, "x-internal-id":"api-v1-applications-upgrade-diff-get", "x-filename-id":"api-v1-applications-upgrade-diff-get" } }, "/api/v1/applications/upgrade":{ "post":{ "tags":[ "Upgrade" ], "summary":"perform upgrade", "description":"for all the applications of a particular Connector. This is an asynchronous task, the result of which can be seen by invoking API getUpgradeStatus", "operationId":"upgrade", "consumes":[ "application/json" ], "parameters":[ { "name":"diffs", "in":"body", "description":"List of all the Authoritative and Target application diffs for a particular connector", "required":false, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ApplicationDiff" } } } ], "responses":{ "default":{ "description":"Successful operation" } }, "x-internal-id":"api-v1-applications-upgrade-post", "x-filename-id":"api-v1-applications-upgrade-post" } }, "/api/v1/applications/upgrade/appstatus":{ "post":{ "tags":[ "Upgrade" ], "summary":"Get the upgrade status of apps", "description":"Returns the upgrade status of every application of a particular connector", "operationId":"getAppUpgradeStatus", "produces":[ "application/json" ], "parameters":[ { "name":"connectorDisplayName", "in":"query", "description":"Connector display Name", "required":false, "type":"string" }, { "name":"connectorVersionName", "in":"query", "description":"latest Connector Version on which to upgrade", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/AppUpgrade" } } } }, "x-internal-id":"api-v1-applications-upgrade-appstatus-post", "x-filename-id":"api-v1-applications-upgrade-appstatus-post" } }, "/api/v1/applications/upgrade/status":{ "post":{ "tags":[ "Upgrade" ], "summary":"Get the upgrade status of every Connector", "description":"Returns the upgrade status of every Connector", "operationId":"getConnectorUpgradeStatus", "produces":[ "application/json" ], "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ConnectorUpgrade" } } } }, "x-internal-id":"api-v1-applications-upgrade-status-post", "x-filename-id":"api-v1-applications-upgrade-status-post" } }, "/api/v1/applications/upgrade/retry":{ "post":{ "tags":[ "Upgrade" ], "summary":"Retry the upgrade process", "description":"Initiates the upgrade process again for a specific connector only if the last connector upgrade status for this connector was not a success", "operationId":"retryUpgrade", "parameters":[ { "name":"body", "in":"body", "description":"List of all the application diffs", "required":false, "schema":{ "type":"array", "items":{ "$ref":"#/definitions/ApplicationDiff" } } } ], "responses":{ "default":{ "description":"Successful operation" } }, "x-internal-id":"api-v1-applications-upgrade-retry-post", "x-filename-id":"api-v1-applications-upgrade-retry-post" } }, "/api/v1/serverTimezoneInformation":{ "get":{ "summary":"Gets the Server Timezone Information", "description":"Returns the time zone information.", "operationId":"getServerTimeZoneData", "produces":[ "application/json" ], "parameters":[ ], "responses":{ "default":{ "description":"Successful operation" } }, "x-internal-id":"api-v1-serverTimezoneInformation-get", "x-filename-id":"api-v1-servertimezoneinformation-get", "tags":[ "General" ] } } }, "definitions":{ "BasicAttribute":{ "type":"object", "properties":{ "category":{ "type":"string", "xml":{ "attribute":true } }, "displayName":{ "type":"string", "xml":{ "attribute":true } }, "name":{ "type":"string", "xml":{ "attribute":true } }, "value":{ "type":"string", "xml":{ "attribute":true } }, "helpText":{ "type":"string", "xml":{ "attribute":true } }, "dataType":{ "type":"string", "xml":{ "attribute":true } }, "required":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "encrypted":{ "type":"boolean", "xml":{ "attribute":true }, "default":false } } }, "ObjectClass":{ "type":"object", "properties":{ "objectClassConfig":{ "type":"array", "xml":{ "name":"objectClassConfigurations", "wrapped":true }, "items":{ "$ref":"#/definitions/Attribute" } }, "reconConfig":{ "$ref":"#/definitions/ReconConfig" }, "provisioningConfig":{ "$ref":"#/definitions/ProvisioningConfig" }, "name":{ "type":"string", "xml":{ "attribute":true } }, "form":{ "$ref":"#/definitions/Form" } } }, "Organization":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "attribute":true } }, "heirarchy":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "type":{ "type":"string", "xml":{ "attribute":true } } } }, "ReconJobParameter":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "attribute":true } }, "value":{ "type":"string", "xml":{ "attribute":true } }, "helpText":{ "type":"string", "xml":{ "attribute":true } }, "dataType":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "String", "Number", "Boolean", "ITResource" ] }, "required":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "encrypted":{ "type":"boolean", "xml":{ "attribute":true }, "default":false } } }, "Capability":{ "type":"object", "properties":{ "actionName":{ "type":"string", "xml":{ "attribute":true } }, "enabled":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "actionScript":{ "type":"array", "xml":{ "name":"actionScripts", "wrapped":true }, "items":{ "$ref":"#/definitions/ActionScript" } }, "failedTaskRetryConfig":{ "$ref":"#/definitions/FailedTaskRetryConfig" }, "failedTaskAssignConfig":{ "$ref":"#/definitions/FailedTaskAssignConfig" } } }, "Attribute":{ "type":"object", "properties":{ "category":{ "type":"string", "xml":{ "attribute":true } }, "displayName":{ "type":"string", "xml":{ "attribute":true } }, "name":{ "type":"string", "xml":{ "attribute":true } }, "value":{ "type":"string", "xml":{ "attribute":true } }, "helpText":{ "type":"string", "xml":{ "attribute":true } }, "dataType":{ "type":"string", "xml":{ "attribute":true } }, "required":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "encrypted":{ "type":"boolean", "xml":{ "attribute":true }, "default":false } } }, "Form":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "attribute":true } }, "backendName":{ "type":"string", "xml":{ "attribute":true } }, "useBulk":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "schemaAttribute":{ "type":"array", "xml":{ "name":"schemaAttributes", "wrapped":true }, "items":{ "$ref":"#/definitions/SchemaAttribute" } }, "form":{ "type":"array", "items":{ "$ref":"#/definitions/Form" } } } }, "SituationResponse":{ "type":"object", "properties":{ "situation":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "noMatch", "singleMatch", "multipleMatch", "oneProcessMatch", "multipleProcessMatch" ] }, "response":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "link", "none", "createUser", "createOrganization", "assignToAdminWithLeastLoad", "assignToAuthWithLeastLoad", "assignToAuthWithHighestPriority", "assignToGroup", "assignToUser" ] } } }, "CIBean":{ "type":"object", "properties":{ "connectorName":{ "type":"string" }, "connectorVersion":{ "type":"string" }, "bundlePkgPath":{ "type":"string" }, "ciXMLPath":{ "type":"string" }, "bundleJarPath":{ "type":"string" } } }, "ProvisioningConfig":{ "type":"object", "properties":{ "allowMultiple":{ "type":"boolean", "default":false }, "caseSensitive":{ "type":"boolean", "default":false }, "accountName":{ "type":"string" }, "accountDiscriminator":{ "type":"string" }, "failedTaskRetryConfig":{ "$ref":"#/definitions/FailedTaskRetryConfig" }, "failedTaskAssignConfig":{ "$ref":"#/definitions/FailedTaskAssignConfig" }, "validationScript":{ "type":"string" }, "transformationScript":{ "type":"string" }, "capability":{ "type":"array", "xml":{ "name":"capabilities", "wrapped":true }, "items":{ "$ref":"#/definitions/Capability" } } } }, "CorrelationRuleElement":{ "type":"object", "properties":{ "targetAttribute":{ "type":"string", "xml":{ "attribute":true } }, "userAttribute":{ "type":"string", "xml":{ "attribute":true } }, "elementOperator":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "Equals", "Contains", "Starts_With", "Ends_With" ] }, "transformName":{ "type":"string", "xml":{ "attribute":true } }, "caseSensitive":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "transformParams":{ "type":"array", "items":{ "$ref":"#/definitions/TransformParams" } } } }, "ReconConfig":{ "type":"object", "required":[ "identityCorrelationRule" ], "properties":{ "jobDetail":{ "type":"array", "xml":{ "name":"reconJobDetails", "wrapped":true }, "items":{ "$ref":"#/definitions/ReconJobDetail" } }, "identityCorrelationRule":{ "$ref":"#/definitions/CorrelationRule" }, "situationResponse":{ "type":"array", "xml":{ "name":"situationResponses", "wrapped":true }, "items":{ "$ref":"#/definitions/SituationResponse" } }, "validationScript":{ "type":"string" }, "transformationScript":{ "type":"string" } } }, "TransformParams":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "attribute":true } }, "value":{ "type":"string", "xml":{ "attribute":true } } } }, "FailedTaskRetryConfig":{ "type":"object", "properties":{ "retryCount":{ "type":"integer", "format":"int32", "xml":{ "attribute":true } }, "retryIntervalInMinutes":{ "type":"integer", "format":"int32", "xml":{ "attribute":true } } } }, "ApplicationUIMetadata":{ "type":"object", "properties":{ "reconSituations":{ "type":"array", "items":{ "type":"string" } }, "reconResponses":{ "type":"array", "items":{ "type":"string" } }, "reconJobModes":{ "type":"array", "items":{ "type":"string" } }, "advanceFlags":{ "type":"array", "items":{ "type":"string" } }, "jobParamDataTypes":{ "type":"array", "items":{ "type":"string" } }, "identityuserattributes":{ "type":"array", "items":{ "type":"string" } }, "fullTypeJobReqParams":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } }, "ruleElementOperator":{ "type":"array", "items":{ "type":"string" } }, "ruleOperator":{ "type":"array", "items":{ "type":"string" } }, "catalogRiskLevelCodeDecodeValueSet":{ "type":"array", "items":{ "$ref":"#/definitions/LookupValue" } }, "dataTypes":{ "type":"array", "items":{ "type":"string" } }, "incrementalTypeJobReqParams":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } }, "deleteTypeJobReqParams":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } }, "entitlementTypeJobReqParams":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } } } }, "CorrelationRule":{ "type":"object", "properties":{ "ruleOperator":{ "type":"string", "xml":{ "attribute":true } }, "ruleElements":{ "type":"array", "items":{ "$ref":"#/definitions/CorrelationRuleElement" } }, "childIdentityCorrelationRule":{ "type":"array", "items":{ "$ref":"#/definitions/CorrelationRule" } } } }, "FailedTaskAssignConfig":{ "type":"object", "properties":{ "entity":{ "type":"string", "xml":{ "attribute":true } }, "entityID":{ "type":"string", "xml":{ "attribute":true } }, "altEmailAddresses":{ "type":"string", "xml":{ "attribute":true } }, "emailTemplate":{ "type":"string", "xml":{ "attribute":true } }, "escalationTimeInMinutes":{ "type":"integer", "format":"int32", "xml":{ "attribute":true } } } }, "ReconJobDetail":{ "type":"object", "properties":{ "jobName":{ "type":"string", "xml":{ "attribute":true } }, "mode":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "Full", "Incremental", "Delete", "Entitlement", "Flat File Full", "Flat File Diff Sync", "Flat File Delete Sync", "Flat File Entitlement", "Flat File Delete" ] }, "parameter":{ "type":"array", "xml":{ "name":"parametersList", "wrapped":true }, "items":{ "$ref":"#/definitions/ReconJobParameter" } } } }, "SchemaAttribute":{ "type":"object", "properties":{ "name":{ "type":"string", "xml":{ "attribute":true } }, "dataType":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "Byte", "Double", "Int", "String", "Short", "Long", "Date", "Boolean", "ByteArray" ] }, "displayName":{ "type":"string", "xml":{ "attribute":true } }, "reconStagingName":{ "type":"string" }, "length":{ "type":"integer", "format":"int32", "xml":{ "attribute":true } }, "udColName":{ "type":"string" }, "identityAttribute":{ "type":"string", "xml":{ "attribute":true } }, "keyField":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "keyFieldCaseInsensitive":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "required":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "fieldType":{ "type":"string", "xml":{ "attribute":true } }, "entitlement":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "reconcileable":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "provisionable":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "encrypted":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "advanceFlags":{ "type":"string", "xml":{ "attribute":true } }, "listOfValues":{ "type":"string", "xml":{ "attribute":true } }, "defaultValue":{ "type":"string", "xml":{ "attribute":true } }, "provideOldValueOnUpdate":{ "type":"boolean", "xml":{ "attribute":true }, "default":false }, "dependentAttribute":{ "type":"string", "xml":{ "attribute":true } } } }, "Application":{ "type":"object", "required":[ "advanceConfig", "applicationName", "connectorDisplayName", "connectorVersion", "objectClass", "organization" ], "properties":{ "applicationName":{ "type":"string" }, "applicationDisplayName":{ "type":"string" }, "description":{ "type":"string" }, "baseApplicationName":{ "type":"string" }, "connectorDisplayName":{ "type":"string" }, "connectorVersion":{ "type":"string" }, "deploymentMode":{ "type":"string", "enum":[ "Local", "Remote" ] }, "connectorDeploymentPath":{ "type":"string" }, "ownerUserName":{ "type":"string" }, "authoritative":{ "type":"boolean", "default":false }, "disconnected":{ "type":"boolean", "default":false }, "basicConfig":{ "type":"array", "xml":{ "name":"basicConfigurations", "wrapped":true }, "items":{ "$ref":"#/definitions/BasicAttribute" } }, "advanceConfig":{ "type":"array", "xml":{ "name":"advanceConfigurations", "wrapped":true }, "items":{ "$ref":"#/definitions/Attribute" } }, "objectClass":{ "type":"array", "items":{ "$ref":"#/definitions/ObjectClass" } }, "catalogAttribute":{ "type":"array", "xml":{ "name":"catalogAttributes", "wrapped":true }, "items":{ "$ref":"#/definitions/Attribute" } }, "organization":{ "type":"array", "xml":{ "name":"organizations", "wrapped":true }, "items":{ "$ref":"#/definitions/Organization" } }, "status":{ "type":"string", "enum":[ "ENABLED", "DISABLED", "ACTIVE", "DELETED" ] }, "parentApplicationName":{ "type":"string" } } }, "JaxbList":{ "type":"object", "properties":{ "list":{ "type":"array", "xml":{ "name":"Item" }, "items":{ "type":"object" } } }, "xml":{ "name":"List" } }, "ActionScript":{ "type":"object", "properties":{ "language":{ "type":"string", "xml":{ "attribute":true } }, "triggerTime":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "Before", "After" ] }, "target":{ "type":"string", "xml":{ "attribute":true }, "enum":[ "Connector", "Resource" ] }, "script":{ "type":"string" } } }, "LookupValue":{ "type":"object", "properties":{ "encodeValue":{ "type":"string" }, "decodeValue":{ "type":"string" } } }, "ApplicationJobDetails":{ "type":"object", "required":[ "jobName", "jobMode", "taskName", "taskStatus" ], "properties":{ "jobName":{ "type":"string" }, "jobMode":{ "type":"string" }, "taskName":{ "type":"string" }, "jobScheduledType":{ "type":"string" }, "startTime":{ "type":"number" }, "endTime":{ "type":"number" }, "nextFireTime":{ "type":"number" }, "lastRunStartTime":{ "type":"number" }, "lastRunEndTime":{ "type":"number" }, "currentStatus":{ "type":"string" }, "retries":{ "type":"integer" }, "runEvery":{ "type":"number" }, "receiverType":{ "type":"string" }, "receiverID":{ "type":"string" }, "taskStatus":{ "type":"boolean", "default":true }, "parameter":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } } } }, "ApplicationJobHistory":{ "type":"object", "required":[ "id", "jobName", "infotype", "jobStartTime", "status" ], "properties":{ "id":{ "type":"number" }, "jobName":{ "type":"string" }, "infotype":{ "type":"string" }, "jobStartTime":{ "type":"number" }, "jobEndTime":{ "type":"number" }, "status":{ "type":"string" }, "errorData":{ "type":"array", "items":{ "type":"string" } }, "exceptionObject":{ "type":"object" }, "customStatus":{ "type":"string" }, "jobRunParams":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } }, "customParams":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } } } }, "ApplicationJobResult":{ "type":"object", "required":[ "id", "jobHistoryId" ], "properties":{ "id":{ "type":"number" }, "jobHistoryId":{ "type":"number" }, "errorLevelString":{ "type":"string" }, "exceptionMessage":{ "type":"string" }, "exceptionObject":{ "type":"object" }, "createBy":{ "type":"string" }, "createTime":{ "type":"string", "format":"date-time" }, "params":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } } } }, "ApplicationJobReport":{ "type":"object", "required":[ "jobExecutionID" ], "properties":{ "jobExecutionID":{ "type":"number" }, "eventCount":{ "type":"number" }, "successfulEvent":{ "type":"number" }, "unsuccessfulEvent":{ "type":"number" }, "toBeProcessed":{ "type":"number" }, "userCreated":{ "type":"number" }, "userUpdated":{ "type":"number" }, "accountCreated":{ "type":"number" }, "accountUpdated":{ "type":"number" }, "userDeleted":{ "type":"number" }, "accountDeleted":{ "type":"number" }, "orphanAccountCreated":{ "type":"number" } } }, "ApplicationDiff":{ "type":"object", "required":[ "addedBasicConfig", "removedBasicConfig", "addedAdvanceConfig", "removedAdvanceConfig", "addedSchemaAttributes", "removedSchemaAttributes", "addedCapabilities", "removedCapabilities", "addedReconJobs", "removedReconJobs", "modifiedReconJobs", "addedChildForms", "removedChildForms", "modifiedChildForms", "childFormSchemaAttributesAddedMap", "basicConfigDiffMap", "advanceConfigDiffMap", "schemaAttributeDiffMap", "childFormDiffMap", "childFormSchemaDiffMap", "capabilityDiffMap", "jobDiffMap", "jobParamDiffMap", "jobParamsAddedMap", "jobModifiedMap", "childFormModifiedMap", "authoritative", "olderVersion", "newVersion", "connectorDisplayName", "appNames" ], "properties":{ "addedBasicConfig":{ "type":"array", "items":{ "$ref":"#/definitions/BasicAttribute" } }, "removedBasicConfig":{ "type":"array", "items":{ "$ref":"#/definitions/BasicAttribute" } }, "addedAdvanceConfig":{ "type":"array", "items":{ "$ref":"#/definitions/Attribute" } }, "removedAdvanceConfig":{ "type":"array", "items":{ "$ref":"#/definitions/Attribute" } }, "addedSchemaAttributes":{ "type":"array", "items":{ "$ref":"#/definitions/SchemaAttribute" } }, "removedSchemaAttributes":{ "type":"array", "items":{ "$ref":"#/definitions/SchemaAttribute" } }, "addedCapabilities":{ "type":"array", "items":{ "$ref":"#/definitions/Capability" } }, "removedCapabilities":{ "type":"array", "items":{ "$ref":"#/definitions/Capability" } }, "addedReconJobs":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobDetail" } }, "removedReconJobs":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobDetail" } }, "modifiedReconJobs":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobDetail" } }, "addedChildForms":{ "type":"array", "items":{ "$ref":"#/definitions/Form" } }, "removedChildForms":{ "type":"array", "items":{ "$ref":"#/definitions/Form" } }, "modifiedChildForms":{ "type":"array", "items":{ "$ref":"#/definitions/Form" } }, "childFormSchemaAttributesAddedMap":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/definitions/SchemaAttribute" } } }, "basicConfigDiffMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "advanceConfigDiffMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "schemaAttributeDiffMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "childFormDiffMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "childFormSchemaDiffMap":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "capabilityDiffMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "jobDiffMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "jobParamDiffMap":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "jobParamsAddedMap":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/definitions/ReconJobParameter" } } }, "jobModifiedMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "childFormModifiedMap":{ "type":"object", "additionalProperties":{ "type":"string" } }, "authoritative":{ "type":"boolean" }, "olderVersion":{ "type":"string" }, "newVersion":{ "type":"string" }, "connectorDisplayName":{ "type":"string" }, "appNames":{ "type":"array", "items":{ "type":"string" } } } }, "AppUpgrade":{ "type":"object", "required":[ "applicationName", "connectorDisplayName", "connectorVersion", "authoritative", "status", "errorMsg" ], "properties":{ "applicationName":{ "type":"string" }, "connectorDisplayName":{ "type":"string" }, "connectorVersion":{ "type":"string" }, "authoritative":{ "type":"boolean" }, "status":{ "type":"string" }, "errorMsg":{ "type":"string" } } }, "ConnectorUpgrade":{ "type":"object", "required":[ "connectorDisplayName", "oldConnectorVersion", "newConnectorVersion", "authoritative", "status" ], "properties":{ "connectorDisplayName":{ "type":"string" }, "oldConnectorVersion":{ "type":"string" }, "newConnectorVersion":{ "type":"string" }, "authoritative":{ "type":"boolean" }, "status":{ "type":"string" } } } } }