WebCenter Imaging REST API v1.1

WebCenter Content Imaging REST API

About the REST APIs

The WebCenter Imaging REST APIs allow you to interact with WebCenter Imaging.

REST Overview

REST, or Representational State Transfer, uses basic methods such as GET, POST, PUT, and DELETE over a standard protocol, such as HTTPS, to submit requests from a client application to operate on objects stored on a server.

A request is in the form of a uniform resource identifier (URI) that identifies the resource on which to operate and includes any parameters necessary for the operation.

Each REST request from the client to a server contains all of the information necessary to understand the request and does not rely on the server to store information about the individual request or about any relationship between requests. Session state is stored (cached) entirely on the client.

Each REST request is translated to an IPM request and the results of the service are returned as a JSON response.

Getting Started

To use WebCenter Imaging REST APIs, install a REST client like Postman.

Authorization

The WebCenter Imaging REST API uses Basic Auth to authenticate REST calls. Anonymous calls are not currently supported.

Resource URI

A REST call includes an HTTPS method, such as POST, GET, PUT, or DELETE, and a resource identified by a Uniform Resource Identifier (URI).

The URI is in this format:

https://{IPMHost}[:IPMPort]/imaging/rest/version/resourcePath

For example:

https://www.example.com/imaging/rest/v1

REST Request

A REST API supports a direct URL and JSON data format for REST requests.

Path Parameters

Path parameters are resource parameters passed directly in the URI resource before the ? character.

Query Parameters

Query parameters are resource parameters passed directly in the URI resource after the ? character.

Body Parameters

Body parameters are resource parameters passed in the HTTP body of the REST request.

REST Response

The REST API supports returning the following data:

The response may return a file.
The response may return in the JSON format.
The response may be empty in which case standard HTTP returns codes that provide an indication of the success or failure of a response.

HTTP Response Codes

The WebCenter Imaging REST APIs may return any valid HTTP response code. The most commonly returned codes are defined in the following table.

HTTP Status Code	Description
200 OK	The request was successfully completed.
400 Bad Request	The request could not be processed because it contains missing or invalid information (such as a validation error on an input field or a missing required value).
401 Unauthorized	The request is not authorized. The authentication credentials included with this request are missing or invalid.
403 Forbidden	The user does not have authorization to perform this request.
404 Not Found	The request includes a resource that does not exist.
500 Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.

REST API Definitions

Connections

List all connections

GET /imaging/rest/v1/connections

Description

This operation will return a collection of the connections in Imaging.

If there are no connections, or they don’t match the filtering criteria, the user sees a message that there are no connections that match the criteria.

Parameters

Name	Description
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or “all”. When expand parameter is specified as “all” (with “all” in lower case), all the child resources of the requested connection are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PERMISSIONS, SECURITY, and DETAILS. Example : ?expand=permissions
q String (query)	The q parameter accepts a query expression condition that matches the name of a connection, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter connections based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is:eq - Equals Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. Two main attributes are supported: name and ability. By default, if no query parameters are provided, connections for which the user has view ability are displayed. The available values for ability parameter are: VIEW, MANAGE , WORKFLOW , and REPOSITORY. Examples: ?q=name eq “Local” OR name eq “Remote” ?q=ability eq “manage” ?q=ability eq “manage” and name eq “Local”

Name

Description

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or “all”. When expand parameter is specified as “all” (with “all” in lower case), all the child resources of the requested connection are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PERMISSIONS, SECURITY, and DETAILS.
Example : ?expand=permissions

q String (query)

The q parameter accepts a query expression condition that matches the name of a connection, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter connections based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is:eq - Equals
Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator.
Two main attributes are supported: name and ability. By default, if no query parameters are provided, connections for which the user has view ability are displayed.
The available values for ability parameter are: VIEW, MANAGE , WORKFLOW , and REPOSITORY.
Examples:
?q=name eq “Local” OR name eq “Remote”
?q=ability eq “manage”
?q=ability eq “manage” and name eq “Local”

Responses

Code	Description
200	A list of all the connections.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch all the connections.

Request

GET …/imaging/rest/v1/connections

Request Body

None

HTTP Response

Status = 200 A list of all connections.

Update a connection

PUT /imaging/rest/v1/connections

Description

This operation is used to modify a connection. It allows for the connection details to be modified in a single operation.

The connection parameter is a connection object and essentially patches the connection with the attributes that are both present in the request body and can be updated. Run a GET of the connection to be modified and copy the output as the request body and make the necessary changes in the request body for updates. Most of the attributes can be updated including:

name, description, details, security, etc.

Parameters

None

Responses

Code	Description
200	A Success message notifying the success of the Modify operation
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Update a connection.

Request

PUT …/imaging/rest/v1/connections

Request Body

The connections object JSON.

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation

Create a connection

POST /imaging/rest/v1/connections

Description

This operation is used to create a new connection. It allows for the connection details to be created in a single operation.

The connection parameter is a connection object and essentially creates the connection with the attributes that are both present in the request body. Run a GET of any connection (GET of a Single Connection and do not copy from the Multi-Fetch) to get a reference object and copy the output as the request body and make the necessary changes in the request body for creation.

Parameters

None.

Responses

Code	Description
200	A Success message notifying the success of the Create operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request

Example

Create a Connection

Request

POST …/imaging/rest/v1/connections

Request Body

The JSON for the connection object.

HTTP Response

Status = 200 Message saying that the create operation was successful.

Get a single connection

GET /imaging/rest/v1/connections/{connectionName}

Description

This operation will return the connection specified by the connectionName parameter.

The expand parameter can be used, which includes child resources inline. The child resource of attachments is supported.|

Parameters

Name	Description
connectionName required String (path)	The unique identifier of the connection in Imaging.
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand parameter is specified as “all” (with “all” in lower case), all child resources of the requested connection are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PERMISSIONS, SECURITY, and DETAILS. Example : ?expand=permissions

Name

Description

connectionName required String (path)

The unique identifier of the connection in Imaging.

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand parameter is specified as “all” (with “all” in lower case), all child resources of the requested connection are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PERMISSIONS, SECURITY, and DETAILS.
Example : ?expand=permissions

Responses

Code	Description
200	The connection specified by connectionName.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The connection was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Download a connection by connection name.

Request

GET …/imaging/rest/v1/connections/{connectionName}

Request Body

None

HTTP Response

Status = 200 The connection object in JSON format.

Delete a Connection

DELETE /imaging/rest/v1/connections/{connectionName}

Description

This operation will delete the connection specified by the connectionName parameter.

Parameters

Name	Located in
connectionName required String (path)	The name of the connection.

Responses

Code	Description
200	A Success message notifying the success of the Delete operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate item where only one is allowed).
404	Not found The connection was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Delete a particular connection with connectionName

Request

DELETE …/imaging/rest/v1/connections/{connectionName}

Request Body

None.

HTTP Response

Status = 200 A Success message notifying the success of the Delete operation.

Applications

List all applications

GET /imaging/rest/v1/applications

Description

This operation will return a collection of the applications in Imaging.

If there are no applications, or they don’t match the filtering criteria, the user sees a message that there are no applications that match the criteria.

Parameters

Name	Description
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or all. When expand parameter is specified as all (in lower case), all child resources of the requested application are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PROPERTIES, FIELDDEFINITIONS, PERMISSIONS, DOCUMENTPERMISSIONS, SECURITY, DOCUMENTSECURITY, LIFECYCLEPOLICY, WORKFLOWCONFIG, and HISTORY. Example : ?expand=permissions
q String (query)	The q parameter accepts a query expression condition that matches the name of an application, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter applications based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. Two main attributes are supported: name and ability. By default, if no query parameters are provided, applications for which the user has view ability are displayed. The available values for ability parameter are: VIEW, MANAGE. Examples: ?q=name eq “Invoices” OR name eq “Receipts” ?q=ability eq “manage” ?q=ability eq “manage” and name eq “Invoices”

Name

Description

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or all. When expand parameter is specified as all (in lower case), all child resources of the requested application are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PROPERTIES, FIELDDEFINITIONS, PERMISSIONS, DOCUMENTPERMISSIONS, SECURITY, DOCUMENTSECURITY, LIFECYCLEPOLICY, WORKFLOWCONFIG, and HISTORY.
Example : ?expand=permissions

q String (query)

The q parameter accepts a query expression condition that matches the name of an application, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter applications based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals
Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses ().
For example: (({expression}) and ({expression})). This forms more complex filters.
Multiple q query parameters are supported, and imply the AND logical operator.
Two main attributes are supported: name and ability.
By default, if no query parameters are provided, applications for which the user has view ability are displayed.
The available values for ability parameter are: VIEW, MANAGE.
Examples:
?q=name eq “Invoices” OR name eq “Receipts”
?q=ability eq “manage”
?q=ability eq “manage” and name eq “Invoices”

Responses

Code	Description
200	A list of all the applications.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch all the applications.

Request

GET …/imaging/rest/v1/applications

Request Body

None

HTTP Response

Status = 200 A list of all applications.

Update an application

PUT /imaging/rest/v1/applications

Description

This operation is used to modify an application. It allows for the application details to be modified in a single operation.

Parameters

None

Responses

Code	Description
200	A Success message notifying the success of the Modify operation
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Update an application.

Request

PUT …/imaging/rest/v1/applications

Request Body

The applications JSON object.

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation

Create an application

POST /imaging/rest/v1/applications

Description

This operation is used to create a new application. It allows for the application details to be created in a single operation.

The application parameter is an application object and essentially creates the application with the attributes that are both present in the request body. Run a GET of any application (GET of a Single Application and do not copy from the Multi-Fetch) to get a reference object and copy the output as the request body and make the necessary changes in the request body for creation.

Parameters

None.

Responses

Code	Description
200	A Success message notifying the success of the Create operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request

Example

Create an Application.

Request

POST …/imaging/rest/v1/applications

Request Body

The JSON for the application object.

HTTP Response

Status = 200 A Success message notifying the success of the Create operation.

Get a single application

GET /imaging/rest/v1/applications/{applicationName}

Description

This operation will return the application specified by the applicationName parameter.

The expand parameter can be used, which includes child resources inline. The child resource of attachments is supported.

Parameters

Name	Description
applicationName required String (path)	The unique identifier of the application in Imaging.
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or all. When expand parameter is specified as all (in lower case), all child resources of the requested application are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PROPERTIES, FIELDDEFINITIONS, PERMISSIONS, DOCUMENTPERMISSIONS, SECURITY, DOCUMENTSECURITY, LIFECYCLEPOLICY, WORKFLOWCONFIG, and HISTORY. Example : ?expand=permissions

Name

Description

applicationName required String (path)

The unique identifier of the application in Imaging.

expand String (query)

Responses

Code	Description
200	The application specified by applicationName.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The application was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch an application by the application name.

Request

GET …/imaging/rest/v1/application/{applicationName}

Request Body

None

HTTP Response

Status = 200 The application specified by the applicationName

Delete an Application

DELETE /imaging/rest/v1/applications/{applicationName}

Description

This operation will delete the application specified by the applicationName parameter.

Parameters

Name	Located in
applicationName required String (path)	The name of the application.

Responses

Code	Description
200	A Success message notifying the success of the Delete operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate item where only one is allowed).
404	Not found The application was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Delete an application.

Request

DELETE …/imaging/rest/v1/applications/{applicationName}

Request Body

None.

HTTP Response

Status = 200 A Success message notifying the success of the Delete operation.

Searches

List all searches

GET /imaging/rest/v1/searches

Description

This operation will return a collection of the searches in Imaging.

If there are no searches, or they don’t match the filtering criteria, the user sees a message that there are no searches that match the criteria.

Parameters

Name	Description
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or all. When expand parameter is specified as “all” (with “all” in lower case), all child resources of the requested search are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PROPERTIES, PARAMETERS, EXPRESSIONS, RESULT_COLUMNS, PERMISSIONS, and SECURITY. Example : ?expand=permissions
q String (query)	The q parameter accepts a query expression condition that matches the name of a search, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter searches based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is:eq - Equals. Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. Two main attributes of are supported: name and ability. By default, if no query parameters are provided, searches for which the user has view ability are displayed. The available values for ability parameter are: VIEW and MANAGE

Name

Description

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or all. When expand parameter is specified as “all” (with “all” in lower case), all child resources of the requested search are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PROPERTIES, PARAMETERS, EXPRESSIONS, RESULT_COLUMNS, PERMISSIONS, and SECURITY.
Example : ?expand=permissions

q String (query)

The q parameter accepts a query expression condition that matches the name of a search, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter searches based on the ability of the user.
The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators.
The conditional operator supported is:eq - Equals.
Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses ().
For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator.
Two main attributes of are supported: name and ability.
By default, if no query parameters are provided, searches for which the user has view ability are displayed. The available values for ability parameter are: VIEW and MANAGE

Responses

Code	Description
200	A list of all the searches.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch all the searches.

Request

GET …/imaging/rest/v1/searches

Request Body

None

HTTP Response

Status = 200 A list of all searches.

Update a search

PUT /imaging/rest/v1/searches

Description

This operation is used to modify a search. It allows for the search details to be modified in a single operation.

Parameters

None

Responses

Code	Description
200	A Success message notifying the success of the Modify operation
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Update a search.

Request

PUT …/imaging/rest/v1/searches

Request Body

The JSON of the search object.

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation

Create a search

POST /imaging/rest/v1/searches

Description

This operation is used to create a new search. It allows for the search details to be created in a single operation.

The search parameter is a search object and essentially creates the search with the attributes that are both present in the request body. Run a GET of any search (GET of a Single Search and do not copy from the Multi-Fetch) to get a reference object and copy the output as the request body and make the necessary changes in the request body for creation.

Parameters

None.

Responses

Code	Description
200	A Success message notifying the success of the Create operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request

Example

Create a Search.

Request

POST …/imaging/rest/v1/searches

Request Body

The JSON for the search object.

HTTP Response

Status = 200 A Success message notifying the success of the Create operation

Get a single search

GET /imaging/rest/v1/searches/{searchName}

Description

This operation will return the search specified by the searchName parameter.

The expand parameter can be used, which includes child resources inline. The child resource of attachments is supported.

Parameters

Name

Description

searchName required String (path)

The unique identifier of the search in Imaging.

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attribute names or all. When expand parameter is specified as “all” (with “all” in lower case), all child resources of the requested search are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PROPERTIES, PARAMETERS, EXPRESSIONS, RESULT_COLUMNS, PERMISSIONS, and SECURITY.
Example : ?expand=permissions

Responses

Code	Description
200	The search specified by searchName.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The search was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch a search by search name.

Request

GET …/imaging/rest/v1/searches/{searchName}

Request Body

None

HTTP Response

Status = 200 The json of the search object

Delete a Search

DELETE /imaging/rest/v1/searches/{searchName}

Description

This operation will delete the search specified by the searchName parameter.

Parameters

Name	Located in
searchName required String (path)	The name of the search.

Responses

Code	Description
200	A Success message notifying the success of the Delete operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate item where only one is allowed).
404	Not found The search was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Delete a search.

Request

DELETE …/imaging/rest/v1/searches/{searchName}

Request Body

None.

HTTP Response

Status = 200 A Success message notifying the success of the Delete operation.

Execute a search

GET /imaging/rest/v1/searches/{searchName}/execute

Description

This operation will execute a persisted search with the given parameters.

Parameters

Name

Description

searchName required String (path)

The unique identifier of the search in Imaging.

q String (query)

The q parameter accepts a query expression condition that matches the search parameters along with the operators defined for that parameter in the search definition. The conditional operators supported are:
•eq - Equals
•ne - Not Equal
•lt - Less than
•gt - Greater than
•le - Less than or Equal
•ge - Greater than or Equal
•sw - Begins With
•ew - Ends With
•co - Contains
Conditional expressions can be joined by the logical operator AND. It can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. The query parameters must match the name defined in the search definition and must also match the operator defined. For field names with spaces in them, please give the field names within double quotes. In case of a parameter of “Date” type, execute /searches/execute/dateTimeFormat to get the default date format that is being used and provide the date in that format. In case of a parameter of “DateTime” type, provide the date along with time in the format returned by the above service.
Examples:
?q=Date3 le “Jul 1, 2024”
?q=Text1 sw “S”
?q=DateTime5 ge “Jul 18, 2024 11:26:25 AM”
?q=“Field Name 1” eq “Test”
?q=“Document Creation Date” gt “Jul 1, 2022 11:26:25 AM” AND “Field Name 1” eq “Test”

Responses

Code	Description
200	The search specified by searchName.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Execute a search by search name.

Request

GET …/imaging/rest/v1/searches/{searchName}/execute

Request Body

None

HTTP Response

Status = 200 The search results.

Get the locale date and time format used for a search execution

GET /imaging/rest/v1/searches/execute/dateTimeFormat

Description

This operation will give the locale default date and time format to be used in search executions.

Parameters

None.

Responses

Code	Description
200	The default date time format for the server locale

Example

Get the default date time format for searches.

Request

GET …/imaging/rest/v1/searches/execute/dateTimeFormat

Request Body

None

HTTP Response

Status = 200 The date time format.

Get the parameters for a search definition

GET /imaging/rest/v1/searches/{searchName}/params

Description

This operation will return the parameters for a Search specified by the searchName parameter.

Parameters

Name	Description
searchName required String (path)	The unique identifier of the search in Imaging.

Responses

Code	Description
200	The search parameters
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Get the parameters for a search specified by searchName.

Request

GET …/imaging/rest/v1/searches/{searchName}/params

Request Body

None

HTTP Response

Status = 200 The search parameters.

Inputs

List all inputs

GET /imaging/rest/v1/inputs

Description

This operation will return a collection of the inputs in Imaging.

If there are no inputs, or they don’t match the filtering criteria, the user sees a message that there are no inputs that match the criteria.

Parameters

Name	Description
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand parameter is specified as all (with all in lower case), all child resources of the requested input are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PROPERTIES, MAPPINGS, PERMISSIONS, SOURCE_PROPERTIES, and SECURITY. Example : ?expand=permissions
q String (query)	The q parameter accepts a query expression condition that matches the name of an input, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter inputs based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals. Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. Two main attributes are supported: name and ability. By default, if no query parameters are provided, inputs for which the user has view ability are displayed. The available values for ability parameter are: VIEW and MANAGE.

Name

Description

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand parameter is specified as all (with all in lower case), all child resources of the requested input are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PROPERTIES, MAPPINGS, PERMISSIONS, SOURCE_PROPERTIES, and SECURITY.
Example : ?expand=permissions

q String (query)

The q parameter accepts a query expression condition that matches the name of an input, and is used for filtering results in collection. The parameter can also accept ability as a condition to filter inputs based on the ability of the user. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals.
Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses ().
For example: (({expression}) and ({expression})). This forms more complex filters.
Multiple q query parameters are supported, and imply the AND logical operator.
Two main attributes are supported: name and ability.
By default, if no query parameters are provided, inputs for which the user has view ability are displayed. The available values for ability parameter are: VIEW and MANAGE.

Responses

Code	Description
200	A list of all the inputs.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch all the inputs.

Request

GET …/imaging/rest/v1/inputs

Request Body

None

HTTP Response

Status = 200 A list of all inputs.

Update an input

PUT /imaging/rest/v1/inputs

Description

This operation is used to modify an input. It allows for the input details to be modified in a single operation.

Parameters

None

Responses

Code	Description
200	A Success message notifying the success of the Modify operation
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Modify an input.

Request

PUT …/imaging/rest/v1/inputs

Request Body

The JSON object for the input.

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation

Create an input

POST /imaging/rest/v1/inputs

Description

This operation is used to create a new input. It allows for the input details to be created in a single operation.

The input parameter is an input object and essentially creates the input with the attributes that are both present in the request body. Run a GET of any input (GET of a Single Input and do not copy from the Multi-Fetch) to get a reference object and copy the output as the request body and make the necessary changes in the request body for creation.

Parameters

None.

Responses

Code	Description
200	A Success message notifying the success of the Create operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request

Example

Create an Input.

Request

POST …/imaging/rest/v1/inputs

Request Body

The JSON for the input object.

HTTP Response

Status = 200 A Success message notifying the success of the Create operation.

Get a single input

GET /imaging/rest/v1/inputs/{inputName}

Description

This operation will return the input specified by the inputName parameter.

The expand parameter can be used, which includes child resources inline. The child resource of attachments is supported.

Parameters

Name	Description
inputName String (path)	The unique identifier of the input in Imaging.
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand parameter is specified as all (with all in lower case), all child resources of the requested input are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error. The available child resources are: NAME, DESCRIPTION, PROPERTIES, MAPPINGS, PERMISSIONS, SOURCE_PROPERTIES, and SECURITY. Example : ?expand=permissions

Name

Description

inputName String (path)

The unique identifier of the input in Imaging.

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand parameter is specified as all (with all in lower case), all child resources of the requested input are expanded. When no expand parameters are provided, name and description child resources would be returned by default. When the expand parameter contains a non-defined child resource, the request operation results in a Bad Request error.
The available child resources are: NAME, DESCRIPTION, PROPERTIES, MAPPINGS, PERMISSIONS, SOURCE_PROPERTIES, and SECURITY.
Example : ?expand=permissions

Responses

Code	Description
200	The input specified by inputName.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The input was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Download an input by input name.

Request

GET …/imaging/rest/v1/inputs/{inputName}

Request Body

None

HTTP Response

Status = 200 The input object JSON is returned.

Delete an Input

DELETE /imaging/rest/v1/inputs/{inputName}

Description

This operation will delete the input specified by the inputName parameter.

Parameters

Name	Located in
inputName required String (path)	The name of the input.

Responses

Code	Description
200	A Success message notifying the success of the Delete operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate item where only one is allowed).
404	Not found The input was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Delete an input.

Request

DELETE …/imaging/rest/v1/inputs/{inputName}

Request Body

None.

HTTP Response

Status = 200 A Success message notifying the success of the Delete operation.

Update state of an Input

PUT /imaging/rest/v1/inputs/state

Description

This operation is used to modify the state of an input definition. It allows for the input details to be modified in a single operation.

It patches the input with the attributes that are both present in the request body and can be updated. The JSON body should have only the field to be modified and the value to be given to the field.

The two fields that are supported are:

ONLINE
PRIORITY

The value parameter accepts a Boolean true or false for the field ONLINE while the field PRIORITY accepts an integer.

Example: application/json: { “field”: “ONLINE”, “value”: true }

Parameters

No parameters

Responses

Code	Description
200	A Success message notifying the success of the Modify operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate item where only one is allowed).
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Update state of an Input.

Request

PUT …/imaging/rest/v1/inputs/state

Request Body

application/json: { “field”: “ONLINE”, “value”: true }

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation.

Update states of an Input

PUT /imaging/rest/v1/inputs/states

Description

This operation is used to modify the states of an input definition. It allows for the input details to be modified in a single operation.

It patches the input with the attributes that are both present in the request body and can be updated. The JSON body should be an array of the field to be modified and the value to be given to the field.

The two fields that are supported are:

ONLINE
PRIORITY

The value parameter accepts a Boolean true or false for the field ONLINE while the field PRIORITY accepts an integer.

Example: application/json: [ { “field”: “ONLINE”, “value”: false }, { “field”: “PRIORITY”, “value”: 2 }]

Parameters

No parameters

Responses

Code	Description
200	A Success message notifying the success of the Modify operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action (e.g. creating a duplicate item where only one is allowed).
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Update states of an Input.

Request

PUT …/imaging/rest/v1/inputs/states

Request Body

[ { “field”: “ONLINE”, “value”: false }, { “field”: “PRIORITY”, “value”: 2 }]

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation.

Get the sample Data sources for a type of input source

GET /imaging/rest/v1/inputs/SampleDataSources/{inputSourceName}

Description

This operation is used to list the sample data sources for an input source type.

Parameters

Name	Description
inputSourceName string (query)	The inputSourceName can have these valid values: CSV Input Source.

Responses

Code	Description
200	A Success message notifying the success of the operation.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Get the sample Data sources for a type of input source.

Request

GET …/imaging/rest/v1/inputs/SampleDataSources/{inputSourceName}

Request Body

None.

HTTP Response

Status = 200

Get the Data from the mentioned sample data source.

GET /imaging/rest/v1/inputs/SampleDataSources/{inputName}/{dataSourceName}/data

Description

This operation is used to get the data for a Sample Data Source.

Parameters

Name	Description
inputName required String (path)	The name of the input.
dataSourceName required String (path)	The name of the data source from which we need to get the data.
q String query	The q parameter accepts a query expression condition that matches the range of the data, and is used for filtering results in the data returned. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can be multiple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals. Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. Two main attributes are supported: startPosition and sampleRange. By default, if no query parameters are provided, the startPosition would be 0 by default and sampleRange would be 10 by default.

Responses

Code	Description
200	A Success message notifying the success of the operation.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

This operation is used to get the data for a Sample Data Source.

Request

GET …/imaging/rest/v1/inputs/SampleDataSources/{inputName}/{dataSourceName}/data

Request Body

None.

HTTP Response

Status = 200

Get the input sections of the sample data source.

GET /imaging/rest/v1/inputs/SampleDataSources/{inputName}/inputSections

Description

This operation is used to get the input sections for a Sample Data Source.

Parameters

Name

Description

inputName required String (path)

The name of the input.

q required String (query)

The q parameter accepts a query expression condition that matches the range of the data, and is used for filtering results in the data returned. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals.
Conditional expressions can be joined by the logical operators of AND. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters.Multiple q query parameters are supported, and imply the and logical operator.
Three main attributes of a are supported:
startPosition
sampleRange
useSampleSource
By default, if no query parameters are provided, the startPosition would be defaulted to 0 and sampleRange would be defaulted to 10. useSampleSource would be defaulted to true.
Examples:
?q=startPosition eq “1”
?q=sampleRange eq “50”
?q=useSampleSource eq “true”

Responses

Code	Description
200	A Success message notifying the success of the operation.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

This operation is used to get the input sections for a Sample Data Source.

Request

GET …/imaging/rest/v1/inputs/SampleDataSources/{inputName}/inputSections

Request Body

None.

HTTP Response

Status = 200

Upload a sample input file of an input source type

POST /imaging/rest/v1/inputs/SampleDataSources/{inputSourceName}/{sampleName}

Description

This operation is used to create a new sample data source of a specific input source type.

It uploads the sample data source with the data that is present in the request body. Please choose content-type as text/plain to upload the data.

Parameters

Name	Description
inputSourceName required String (path)	The name of the type of input source. Typically it will be CSV Input Source.
sampleName required String (path)	The name of the sample to be uploaded.

Responses

Code	Description
200	A Success message notifying the success of the operation.
400	Bad request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Upload a sample input file of an input source type.

Request

POST …/imaging/rest/v1/inputs/SampleDataSources/{inputSourceName}/{sampleName}

Request Body

None.

HTTP Response

Status = 200 A Success message notifying the success of the operation.

Document Content operations

Get a particular document based on document Id

GET /imaging/rest/v1/documentContent/{documentId}

Description

This operation will return a document from Imaging based on the document Id as a downloadable file.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging

Responses

Code	Description
200	The document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch a particular document.

Request

GET …/imaging/rest/v1/documentContent/{documentId}

Request Body

None

HTTP Response

Status = 200 The document, which can be downloaded as a file locally.

Get a particular document based on document Id and Version

GET /imaging/rest/v1/documentContent/{documentId}/{version}

Description

This operation will return a document from Imaging based on the document Id and version as a downloadable file.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
version required String (path)	The version of the imaging document

Responses

Code	Description
200	The document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Download a particular document for a specified version.

Request

GET …/imaging/rest/v1/documentContent/{documentId}/{version}

Request Body

None

HTTP Response

Status = 200 The document, which can be downloaded as a file locally.

Get a page’s render result based on document Id

GET /imaging/rest/v1/documentContent/page/{documentId}

Description

This operation will return the page’s render result object for document from Imaging based on the document Id. The render options can also be passed optionally via the query parameter. If no render options are passed, then default render options are used.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name

Description

documentId required String (path)

The document Id of the document in Imaging

q String query

The q parameter accepts a query expression condition that matches the rendition options for the document. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators.Only the “eq” conditional operator is supported.The rendition option attributes are: fitMode,scaleFactor,outputFormat,rotation,pageNumber and withAnnotations By default, if no query parameters are provided, default rendition options are used. The default values are: fitMode eq “FITSCALE” and scaleFactor eq “100” and OutputFormat eq “TIFF” and rotation eq “ZERO” and pageNumber eq “1” and withAnnotations eq “true”.
The available values for fitMode parameter are: FITSCALE,FITHEIGHT,FITWIDTH,FITBEST.
The available values for outputFormat parameter are: NATIVE,GIF,JPEG,PNG,TIFF.
The available values for rotation parameter are: ZERO, NINETY, TWO_SEVENTY,ONE_EIGHTY, PAGE.
The available values for scaleFactor parameter are between 20 and 200

Responses

Code	Description
200	The page’s render result object
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch a page’s render result object.

Request

GET …/imaging/rest/v1/documentContent/page/{documentId}

Request Body

None

HTTP Response

Status = 200 The specified page’s render result object.

Get a page’s render result based on document Id and version

GET /imaging/rest/v1/documentContent/page/{documentId}/{version}

Description

This operation will return the page’s render result object for document from Imaging based on the document Id and version. The render options can also be passed optionally via the query parameter. If no render options are passed, then default render options are used.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
version required String (path)	The version of the document in Imaging
q String query	The q parameter accepts a query expression condition that matches the rendition options for the document. The value of the parameter can be a simple expression in the form of {attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators.Only the “eq” conditional operator is supported. The rendition option attributes are: fitMode,scaleFactor,outputFormat,rotation,pageNumber and withAnnotations By default, if no query parameters are provided, default rendition options are used. The default values are: fitMode eq “FITSCALE” and scaleFactor eq “100” and OutputFormat eq “TIFF” and rotation eq “ZERO” and pageNumber eq “1” and withAnnotations eq “true”. The available values for fitMode parameter are: FITSCALE,FITHEIGHT,FITWIDTH,FITBEST. The available values for outputFormat parameter are: NATIVE,GIF,JPEG,PNG,TIFF. The available values for rotation parameter are: ZERO, NINETY, TWO_SEVENTY,ONE_EIGHTY, PAGE. The available values for scaleFactor parameter are between 20 and 200

Responses

Code	Description
200	The page’s render result json object.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch a page’s render result object.

Request

GET …/imaging/rest/v1/documentContent/page/{documentId}/{version}

Request Body

None

HTTP Response

Status = 200 The specified page’s render result object.

Get Renditon for the pages based on document Id

GET /imaging/rest/v1/documentContent/rendition/{documentId}/{withAnnotations}/{preserveColor}/{outputType}/{pages}

Description

This operation will return the Rendition json object for the pages specified in the document from Imaging based on the document Id.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
withAnnotations required Boolean (path)	Whether annotations are required or not
preserveColor required Boolean (path)	Whether color should be preserved or not
outputType required String (path)	Allowed values are TIFF or ORIGINALORTIFF
pages required String (path)	An array of page numbers enclosed in square brackets and separated by commas. Example: [1,3,7]

Responses

Code	Description
200	The Rendition object for the specified pages.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the Rendition json object based on the parameters passed.

Request

GET …/imaging/rest/v1/documentContent/rendition/{documentId}/{withAnnotations}/{preserveColor}/{outputType}/{pages}

Request Body

None

HTTP Response

Status = 200 The Rendition json object for the specified pages.

Get Rendition for the pages based on document Id and Version

GET /imaging/rest/v1/documentContent/rendition/{documentId}/{version}/withAnnotations}/{preserveColor}/{outputType}/{pages}

Description

This operation will return the Rendition json object for the pages specified in the document from Imaging based on the document Id and version.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
version required int (path)	The version of the document
withAnnotations required Boolean (path)	Whether annotations are required or not
preserveColor required Boolean (path)	Whether color should be preserved or not
outputType required String (path)	Allowed values are TIFF or ORIGINALORTIFF
pages required String (path)	An array of page numbers enclosed in square brackets and separated by commas. Example: [1,3,7]

Responses

Code	Description
200	The Rendition object for the specified pages.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the Rendition json object based on the parameters passed.

Request

GET …/imaging/rest/v1/documentContent/rendition/{documentId}/{version}/{withAnnotations}/{preserveColor}/{outputType}/{pages}

Request Body

None

HTTP Response

Status = 200 The Rendition json object for the specified pages.

Upload a document

POST /imaging/rest/v1/documentContent/{fileName}

Description

This operation will upload a document to the server machine in a temporary location and return a token. While making the POST request, make sure that this request header is also passed: Content-Type = application/octet-stream.

This upload token can be subsequently used in the Document APIs.

This operation also returns a JSessionId cookie. This cookie is later used to check-in the uploaded document using ‘createDocument’ operation of DocumentService.

Parameters

Name	Description
fileName required String (path)	The file name of the document with the extension

Responses

Code	Description
200	The upload token.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Upload a document and fetch the token.

Request

POST …/imaging/rest/v1/documentContent/{fileName}

Request Body

The file to be uploaded.

HTTP Response

Status = 200 The upload token.

Get the documents for a list of Imaging document Ids

GET /imaging/rest/v1/documents

Description

This operation will get multiple Document data structures containing the requested detail sections for a list of Imaging document ids

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name

Description

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand is specified as all (with all in lower case), all child resources of the requested document are expanded. When no expand parameters are provided, name and description child resources would be returned by default.
The available values are: PROPERTIES,FIELDVALUES,PERMISSIONS. By default PROPERTIES section will be expanded.
Example : ?expand=PERMISSIONS, returns a collection of permissions of this document.

q String (query)

The q parameter accepts a query expression condition that matches the name of an document, and is used for filtering results in collection. {attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators. The following conditional operator is supported: eq - Equals. Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple “q” query parameters are supported, and imply the AND logical operator.
Supported attribute: id
Examples: ?q=id eq “19.IPM_014603” and id eq “19.IPM_014011”

Responses

Code	Description
200	A list of all the document details.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the details for a list of document ids.

Request

GET …/imaging/rest/v1/documents

Request Body

None

HTTP Response

Status = 200 The requested document details.

Delete the documents for a list of document ids.

DELETE /imaging/rest/v1/documents

Description

This operation will delete multiple Documents for a list of Imaging document ids

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name

Description

q String (query)

The q parameter accepts a query expression condition that matches the name of an document, and is used for filtering results in collection. {attribute name} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators. The conditional operator supported is: eq - Equals.
Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple “q” query parameters are supported, and imply the AND logical operator.
Supported attribute: id
Examples: ?q=id eq “19.IPM_014603” and id eq “19.IPM_014011”

Responses

Code	Description
200	A Success message notifying the success of the Delete operation.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
403	Forbidden The request was valid and was understood, but the server is refusing action. This may be due to the account not having the necessary permissions for a resource, or attempting a prohibited action.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Delete multiple Documents for a list of Imaging document ids

Request

DELETE …/imaging/rest/v1/documents

Request Body

None

HTTP Response

Status = 200 A Success message notifying the success of the Delete operation.

Display document details by documentId

GET /imaging/rest/v1/documents/{documentId}

Description

This operation will return the Document data structure containing the detail sections for latest version of a given imaging document specified by the document Id.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name

Description

documentId required String (path)

The imaging document id

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand is specified as all (with all in lower case), all child resources of the requested document are expanded. When no expand parameters are provided, name and description child resources would be returned by default.
The available values are: PROPERTIES,FIELDVALUES,PERMISSIONS.
By default PROPERTIES section will be expanded.
Example : ?expand=PERMISSIONS, returns a collection of permissions of this document.

Responses

Code	Description
200	The Document data structure containing the detail sections for latest version of a given imaging document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The requested document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the details for a document id.

Request

GET …/imaging/rest/v1/documents/{documentId}

Request Body

None

HTTP Response

Status = 200 The Document data structure containing the detail sections for latest version of a given imaging document.

Delete the document specified by the documentId.

DELETE /imaging/rest/v1/documents/{documentId}

Description

This operation will delete, the document specified by the documentId parameter.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The imaging document id

Responses

Code	Description
200	A Success message notifying the success of the Delete operation.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The requested document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Delete the document with a particular document id.

Request

DELETE …/imaging/rest/v1/documents/{documentId}

Request Body

None

HTTP Response

Status = 200 A Success message notifying the success of the Delete operation.

Display document details for a particular document id and version.

GET /imaging/rest/v1/documents/{documentId}/version/{version}

Description

This operation will return the Document data structure containing the detail sections for specified version of a given imaging document specified by the document Id.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
documentId required String (path)	The imaging document id
version required String (path)	The document version
expand String (query)	The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand is specified as all (with all in lower case), all child resources of the requested document are expanded. When no expand parameters are provided, name and description child resources would be returned by default. The available values are: PROPERTIES,FIELDVALUES,PERMISSIONS. By default PROPERTIES section will be expanded. Example : ?expand=PERMISSIONS, returns a collection of permissions of this document.

Responses

Code	Description
200	The Document data structure containing the detail sections for specified version of a given imaging document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The document was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the detail sections for an imaging document id and version.

Request

GET …/imaging/rest/v1/documents/{documentId}/version/{version}

Request Body

None

HTTP Response

Status = 200 The Document data structure containing the detail sections for specified version of a given imaging document.

Lock document

GET /imaging/rest/v1/documents/{documentId}/lock

Description

This operation locks a document to the requesting user. The specified sections of the locked document are returned in a Document data structure.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

The operation will throw an error message if the document is already locked to another user.

Parameters

Name

Description

documentId required String (path)

The imaging document id

expand String (query)

The expand parameter provides the option of getting child resources (referenced items) inline with the response. It accepts a comma-separated list of attributes names or all. When expand is specified as all (with all in lower case), all child resources of the requested document are expanded. When no expand parameters are provided, name and description child resources would be returned by default.
The available values are: PROPERTIES,FIELDVALUES,PERMISSIONS.
By default PROPERTIES section will be expanded.
Example :?expand=PERMISSIONS, returns a collection of permissions of this document.

Responses

Code	Description
200	The Document data structure containing the detail sections of the successfully locked imaging document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Locks a document to the requesting user. The specified sections of the locked document are returned in a Document data structure.

Request

GET …/imaging/rest/v1/documents/{documentId}/lock

Request Body

None

HTTP Response

Status = 200 The Document data structure containing the detail sections of the successfully locked imaging document.

Unlock document

GET /imaging/rest/v1/documents/{documentId}/unlock

Description

This operation unlocks a document from the requesting user.

If there is no document which matches the filtering criteria, the user sees an appropriate message.

The operation will throw an error message if the document is not locked to the requesting user, or if the user does not have rights to unlock documents.

Parameters

Name	Description
documentId required String (path)	The imaging document id

Responses

Code	Description
200	A Success message notifying the success of the Unlock operation.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Unlock a particular document.

Request

GET …/imaging/rest/v1/documents/{documentId}/unlock

Request Body

None

HTTP Response

Status = 200 A Success message notifying the success of the Unlock operation.

Application details for given application name

GET /imaging/rest/v1/documents/target/{AppName}

Description

This operation will return the Application data structure containing the detail sections for specified application name

If there is no application which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
appName String (path)	The application name

Responses

Code	Description
200	The Application data structure containing the detail sections for the specified application name.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the details of a particular application.

Request

GET …/imaging/rest/v1/documents/target/{appName}

Request Body

None

HTTP Response

Status = 200 The Application data structure containing the detail sections for the specified application name.

List of applications for given ablility

GET /imaging/rest/v1/documents/targetApplications

Description

This operation will list the Applications that the user has access to, for the given abilities.

If there is no application which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name

Description

q String (query)

The q parameter accepts a query expression condition that matches the ability of a user, and is used for filtering results in collection. {attribute id} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators. The conditional operator supported is:
eq - Equals.
Supported attribute:“ability”.
Supported attribute values: “viewdocument” and “createdocument”. By default documents matching viewdocument ability shall be displayed.
Example:?q=ability eq “createdocument”

Responses

Code	Description
200	The names of applications that the user has access to, for the given abilities.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the list of applications for given abilities. ##### Request

GET …/imaging/rest/v1/documents/targetApplications

Request Body

None

HTTP Response

Status = 200 The names of applications that the user has access to, for the given abilities.

Application details for given App Name

GET /imaging/rest/v1/documents/target/{AppName}

Description

This operation will return the Application data structure containing the detail sections for specified application name

If there is no application which matches the filtering criteria, the user sees an appropriate message.

Parameters

Name	Description
appName String (path)	The application name

Responses

Code	Description
200	The Application data structure containing the detail sections for the specified application name.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the details of a particular application.

Request

GET …/imaging/rest/v1/documents/target/{appName}

Request Body

None

HTTP Response

Status = 200 The Application data structure containing the detail sections for the specified application name.

Download the annotation document.

GET /imaging/rest/v1/documents/{documentId}/annotation

Description

This operation will return the annotation document as a downloadable, for the specified document in Imaging.

If there is no annotation document, the user sees an empty AnnotationSet xml with no meaningful data.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging

Responses

Code	Description
200	The annotation document as a downloadable file for the specified document id.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the annotation document.

Request

GET …/imaging/rest/v1/documents/{documentId}/annotation

Request Body

None

HTTP Response

Status = 200 The annotation document as a downloadable file for the specified document id.

Download the supporting document.

GET /imaging/rest/v1/documents/{documentId}/supporting/{key}

Description

This operation will return the supporting content document as a downloadable, for the specified document in Imaging.

The operation will display an exception message if there is no content for the requested key or if the requesting user doesn’t have rights to View. #### Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
key required String (path)	The supporting content key

Responses

Code	Description
200	The Supporting document as a downloadable file for the specified document id and Supporting Content Key
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Fetch the supporting document.

Request

GET …/imaging/rest/v1/documents/{documentId}/supporting/{key}

Request Body

None

HTTP Response

Status = 200 The Supporting document as a downloadable file for the specified document id and Supporting Content Key.

Submit to workflow

GET /imaging/rest/v1/documents/{documentId}/submitToWorkflow

Description

This operation triggers the creation of a workflow process instance for a given document.

If the application is not configured for workflow, the operation takes no action but returns succeessfully.

A process instance is only created if the application in which the document was created is configured for workflow and the calling user must have permissions to view the document for this operation to succeed.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging

Responses

Code	Description
200	A Success message notifying the success of the Submit To Workflow operation.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Submit the document to workflow.

Request

GET …/imaging/rest/v1/documents/{documentId}/submitToWorkflow

Request Body

None

HTTP Response

Status = 200 A Success message notifying the success of the Submit To Workflow operation.

Determine if a document’s status has changed.

GET /imaging/rest/v1/documents/{documentId}/status/{status}

Description

This operation determines if a document’s status has changed.

The document status tracks whether changes have occurred to the document (content or annotations) since the document was retrieved.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
status required String (path)	The timestamp of the last edit to the document. This is stored in the UCM tables under the xIPMSYS_STATUS field for the document

Responses

Code	Description
200	true if document status has changed(status value is different from what is present in the table), otherwise false
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Determine if a document’s status has changed.

Request

GET …/imaging/rest/v1/documents/{documentId}/status/{status}

Request Body

None

HTTP Response

Status = 200 true if document status has changed(status value is different from what is present in the table), otherwise false

Upload a supporting content document.

POST /imaging/rest/v1/documents/{documentId}/supporting/{key}/{fileName}

Description

This operation will upload a supporting content document and attach it with the specified document.

If there is no document, the user sees a error message that there is no document that matches the criteria.

If a supporting content with the given key already exists, the user sees a error message.

In order to use this, choose ‘binary’ as the type and upload the file. Also ensure Content-Type header is set to application/octet-stream

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
key required String (path)	The supporting content key
fileName required String (path)	The file name and extention

Responses

Code	Description
200	A Success message notifying the success of the Create Supporting Content operation.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Create a supporting content.

Request

POST …/imaging/rest/v1/documents/{documentId}/supporting/{key}/{fileName}

Request Body

The binary file content.

HTTP Response

Status = 200 true if document status has changed(status value is different from what is present in the table), otherwise false

Modify page order

GET /imaging/rest/v1/documents/{documentId}/modifyPageOrder

Description

This operation affects the page changes described by the collection of PageChange objects in the supplied collection.

If there is no document, the user sees a error message that there is no document that matches the criteria.

Two of the sub-operations “AppendPage” and “InsertPage” requires an ‘uploadToken’ attribute to be passed. This is obtained from ‘uploadDocument’ operation of the DocumentContentService. The ‘uploadDocument’ operation returns both an ‘uploadToken’ as well as the JSessionId in its response. Both of these will be used in the current operation.

If the modification is an Append or an Insert, this becomes a stateful operation and it requires a JSessionId to be passed as a header parameter like below -

Name of the header - Cookie Value - JSESSIONID=87GE6Vn4Vc4NDvKYYrqfRSmkcUGkGYm0zN4pkmdCUJo7xjf4LnRM!-1189823720

Parameters

Name

Description

documentId required String (path)

The document Id of the document in Imaging

q required String (query)

The q parameter accepts a query expression condition that matches the page changes required to be made to the document. {attribute id} {condition operator} {attribute value}, or it can muliple expressions grouped and combined with logical operators. The conditional operator supported is:eq - Equals.
Conditional expressions can be joined by the logical operators of AND or OR. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator.
Supported attribute pageChangeKeys.
The pageChangeKeys is a list of keys to be read from the query expression.
For Example, a pageChangeKey of “change0” would mean there are sub-attributes which will contain further detail on the type of change and also some supplementary attributes. Please go through the examples which are self-explanatory.
The sub-attributes can detail four page operations(changeType) - “AppendPage”, “InsertPage”, “DeletePage” and “MovePage”. The “AppendPage” operation requires the upload token.
The “InsertPage” operation requires the upload token and the “newPageNumber” attributes to be provided.
The “DeletePage” operation requires the “currentPageNumber” attribute to be given along with it.
Similarly the “MovePage” operation requires “currentPageNumber” as well as “newPageNumber” attributes to be provided.
Examples:
?q=pageChangeKeys eq “change0” AND change0.changeType eq “DeletePage” AND change0.currentPageNumber eq “9”
?q=pageChangeKeys eq “change0, change1” AND change0.changeType eq “DeletePage” AND change0.currentPageNumber eq “9” AND change1.changeType eq “DeletePage” AND change1.currentPageNumber eq “8”
?q=pageChangeKeys eq “change0” AND change0.changeType eq “MovePage” AND change0.currentPageNumber eq “1” AND change0.newPageNumber eq “2”
?q=pageChangeKeys eq “change0” AND change0.changeType eq “AppendPage” AND change0.uploadToken eq “IPM7366479670787127097”
?q=pageChangeKeys eq “change0” AND change0.changeType eq “InsertPage” AND change0.uploadToken eq “IPM324743684800306433” AND change0.newPageNumber eq “4”

Responses

Code	Description
200	A Success message notifying the success of the Modify operation.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Modify the page order.

Request

GET …/imaging/rest/v1/documents/{documentId}/modifyPageOrder

Request Body

None

HTTP Response

Status = 200 A Success message notifying the success of the Modify operation.

Copy a document in imaging.

GET /imaging/rest/v1/documents/{documentId}/copy/{appName}/{copyAnnotations}

Description

This operation copies a document in the imaging system from one application to another.

If there is no document, the user sees a error message that there is no document that matches the criteria.

Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
appName required String (path)	The application name
copyAnnotations required Boolean (path)	Whether annotations are required to be copied or not. Default value is false.
q	The q parameter accepts a query expression condition that matches the field names and values as per what is defined in the application definition. The conditional operator supported is: eq - Equals. Conditional expressions can be joined by the logical operator AND. It can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple “q” query parameters are supported, and imply the AND logical operator. The query parameters must match the name defined in the application definition. For field names with spaces in them, please give the field names within double quotes. In case of a parameter of “Date” type, execute /searches/execute/dateTimeFormat to get the default date format that is being used and provide the date in that format. In case of a parameter of “DateTime” type, provide the date along with time in the format returned by the above service. Examples: ?q=Text1 eq “Test”

Responses

Code	Description
200	A Success message returning the Imaging Document Id of the newly created document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Copy a document.

Request

GET …/imaging/rest/v1/documents/{documentId}/copy/{appName}/{copyAnnotations}

Request Body

None

HTTP Response

Status = 200 A Success message returning the Imaging Document Id of the newly created document.

Move a document in imaging.

GET /imaging/rest/v1/documents/{documentId}/move/{appName}

Description

This operation moves a document in the imaging system from one application to another.

If there is no document, the user sees a error message that there is no document that matches the criteria. #### Parameters

Name	Description
documentId required String (path)	The document Id of the document in Imaging
appName required String (path)	The application name
q String (query)	The q parameter accepts a query expression condition that matches the field names and values as per what is defined in the application definition. The conditional operator supported is: eq - Equals. Conditional expressions can be joined by the logical operator AND. It can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. The query parameters must match the name defined in the application definition. For field names with spaces in them, please give the field names within double quotes. In case of a parameter of “Date” type, execute /searches/execute/dateTimeFormat to get the default date format that is being used and provide the date in that format. In case of a parameter of “DateTime” type, provide the date along with time in the format returned by the above service. Examples: ?q=Text1 eq “Test”

Responses

Code	Description
200	A Success message returning the Imaging Document Id of the newly created document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Move document

Request

GET …/imaging/rest/v1/documents/{documentId}/move/{appName}

Request Body

None

HTTP Response

Status = 200 A Success message returning the Imaging Document Id of the newly created document.

Create document in imaging.

GET /imaging/rest/v1/documents/create/{uploadToken}/{appName}/{submitToWorkflow}

Description

This operation creates a document in the Imaging System.

This operation is preceeded by ‘uploadDocument’ operation of the DocumentContentService. The ‘uploadDocument’ operation returns both an ‘uploadToken’ as well as the JSessionId in its response. Both of these are to be used in the current operation.

This operation is a stateful operation. This requires a JSessionId to be passed as a header parameter like below -

Name of the header - Cookie Value - JSESSIONID=87GE6Vn4Vc4NDvKYYrqfRSmkcUGkGYm0zN4pkmdCUJo7xjf4LnRM!-1189823720

Parameters

Name	Description
uploadToken required String (path)	The document Id of the document in Imaging
appName required String (path)	The application name
submitToworkflow required Boolean (path)	Whether the newly created document should be submitted for Workflow. Default value is false.
q String (query)	The q parameter accepts a query expression condition that matches the field names and values as per what is defined in the application definition. The conditional operator supported is: eq - Equals. Conditional expressions can be joined by the logical operator AND. And, can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. The query parameters must match the name defined in the application definition. For field names with spaces in them, please give the field names within double quotes. In case of a parameter of “Date” type, execute /searches/execute/dateTimeFormat to get the default date format that is being used and provide the date in that format. In case of a parameter of “DateTime” type, provide the date along with time in the format returned by the above service. Examples: ?q=Text1 eq “Test”

Responses

Code	Description
200	A Success message returning the Imaging Document Id of the newly created document.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Create a document

Request

GET …/imaging/rest/v1/documents/create/{uploadToken}/{appName}/{submitToWorkflow}

Request Body

None

HTTP Response

Status = 200 A Success message returning the Imaging Document Id of the newly created document.

Update document in imaging.

GET /imaging/rest/v1/documents/update/{uploadToken}/{reserved}

Description

This operation updates a document in the Imaging System.

This operation can work two ways, updation of just the metadata or updating the file as well. If only metadata is to be updated, give the value for uploadToken as ‘null’. Otherwise, pass the uploadToken. In that case, this operation is to be preceeded by ‘uploadDocument’ operation of the DocumentContentService. The ‘uploadDocument’ operation returns both an ‘uploadToken’ as well as the JSessionId in its response. Both of these are to be used in the current operation and you can pass the JsessionId in the header as below -

Name of the header - Cookie Value - JSESSIONID=87GE6Vn4Vc4NDvKYYrqfRSmkcUGkGYm0zN4pkmdCUJo7xjf4LnRM!-1189823720

Parameters

Name	Description
uploadToken required String (path)	The document Id of the document in Imaging
reserved required String (path)	Reserved for future use. Default value is false
q String (query)	The q parameter accepts a query expression condition that matches the field names and values as per what is defined in the application definition. The conditional operator supported is:eq - Equals . Conditional expressions can be joined by the logical operator AND. It can also be grouped using parentheses (). For example: (({expression}) and ({expression})). This forms more complex filters. Multiple q query parameters are supported, and imply the AND logical operator. The query parameters must match the name defined in the application definition. For field names with spaces in them, please give the field names within double quotes. In case of a parameter of “Date” type, execute /searches/execute/dateTimeFormat to get the default date format that is being used and provide the date in that format. In case of a parameter of “DateTime” type, provide the date along with time in the format returned by the above service. Examples: ?q=Text1 eq “Test”

Responses

Code	Description
200	A Success message returning the Imaging Document Id of the updated document..
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Update a document

Request

GET …/imaging/rest/v1/documents/update/{uploadToken}/{reserved}

Request Body

None

HTTP Response

Status = 200 A Success message returning the Imaging Document Id of the updated document.

Import Export

Perform export.

GET /imaging/rest/v1/importexport/performexport

Description

This operation will export the imaging data definition containing collection of application, search and input.

Atleast one object out of application, search or input must be provided for this operation to process and obtain data definition.

If there are no matching data found for application, search or input, the user sees a message that the requested data is not found.

Parameters

Name	Description
appName array[string] (query)	The appName parameter accepts an imaging application name. We can pass multiple appName parameters if we want to export collection of application in the exported definition. Example: For exporting two imaging applications by name imaging-app1 and imaging-app2 the parameters can be specified as below: appName=imaging-app1&appName=imaging-app2
searchName array[string] (query)	The searchName parameter accepts an imaging saved search name. We can pass multiple searchName parameters if we want to export collection of saved search in the exported definition. Example: For exporting two imaging saved searches by name imaging-search1 and imaging-search2 the parameters can be specified as below: searchName=imaging-search1&searchName=imaging-search2
inputName array[string] (query)	The inputName parameter accepts an imaging input name. We can pass multiple inputName parameters if we want to export collection of input in the exported definition. Example: For exporting two imaging inputs by name imaging-input1 and imaging-input2 the parameters can be specified as below: inputName=imaging-input1&inputName=imaging-input2
exportComments string (query)	The exportComments parameter accepts a detailed description of the definition we want to export. Example: exportComments=IPM Invoice related export defintion.

Responses

Code	Description
200	Imaging data definition containing collection of application, search and input.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The supplied parameter was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Export the imaging data definition.

Request

GET …/imaging/rest/v1/importexport/performexport

Request Body

None

HTTP Response

Status = 200 Imaging data definition containing collection of application, search and input.

Perform import.

PUT /imaging/rest/v1/importexport/performimport

Description

This operation will import the imaging data definition containing collection of application, search and input.

The exported data obtained from performexport service can be used to perform this import operation.

During the import if the data is already existing in the system then the imported data gets updated else it gets created. The user sees a message that the requested data is updated. If data provided is not found, the user will see relevant error in the response.

Parameters

None.

Responses

Code	Description
200	Imaging data definition containing collection of application, search and input was imported successfully.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
404	Not found The supplied parameter was not found.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Import the imaging data definition.

Request

PUT …/imaging/rest/v1/importexport/performimport

Request Body

The exported data obtained from performexport service should be used to perform this import operation.

HTTP Response

Status = 200 Imaging data definition containing collection of application, search and input was imported successfully.

Validate the imaging data to be imported.

POST /imaging/rest/v1/importexport/performvalidation

Description

This operation will validate the imaging data definition containing collection of application, search and input.

The exported data obtained from performexport service can be used to perform this validation operation.

The user sees a message that the submitted data was successfully validated or not. If data provided is not found, the user will see relevant error in the response.

Parameters

None.

Responses

Code	Description
200	Imaging data definition containing collection of application, search and input was validated successfully.
400	Bad Request The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value.
500	Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.

Example

Validate the imaging data definitions to be imported.

Request

POST …/imaging/rest/v1/importexport/performvalidation

Request Body

The exported data obtained from performexport service should be used to perform this validation operation.

HTTP Response

Status = 200 Imaging data definition containing collection of application, search and input was validated successfully.

Models

Connection

Name	Type	Description	Required
id	string	The unique identifier of the connection in Imaging.	Yes
name	string	The name of the connection. This is generally the name that is used by other resources.	No
description	string	The description of the connection. A small description of the connection object.	No
details	string	The details of this connection. Details like the type of repository, the machine and port details.	No
security	string	The security section for this connection. Array of Users and Groups with their respective permissions for this connection object.	No
permissions	string	The permissions section for this connection. Specifies the current user’s permissions to the connection.	No

Application

Name	Type	Description	Required
id	string	The unique identifier of the application in Imaging.	Yes
name	string	The name of the application. This is generally the name that is used by other resources.	No
description	string	The description of the application. A small description of the application object.	No
fieldDefinitions	string	The definitions of fields present in the application. Describes all the properties of the field like name, type, length, etc.	No
properties	string	The properties of this application. Details like the type of repository, the full-text option, etc.	No
security	string	The security section for this application. Array of Users and Groups with their respective permissions for this application object.	No
documentSecurity	string	The documentsecurity section for this application. Array of Users and Groups with their respective permissions for the documents that belong to this application.	No
lifecyclePolicy	string	The section which provides details about the storage options for this application.	No
workflowConfig	string	The Workflow config section for this application. Provides details about the workflow connections for this application and the respective payload properties.	No

Search

Name	Type	Description	Required
id	string	The unique identifier of the search in Imaging.	Yes
name	string	The name of the search. This is generally the name that is used by other resources.	No
description	string	The description of the search. A small description of the search object.	No
parameterDefinitions	string	Defines all the parameters for the search.	No
searchExpressions	string	The search conditions are defined.	No
resultColumns	string	The columns that are displayed in the search results page.	No
permissions	string	The permissions section for this Search. Array of Users and Groups with their respective permissions for this search object.	No

Input

Name	Type	Description	Required
id	string	The unique identifier of the input in Imaging.	Yes
name	string	The name of the input. This is generally the name that is used by other resources.	No
description	string	The description of the input. A small description of the connection object.	No
mappings	string	The mapping of the input field to the application fields.	No
properties	string	Whether the input is online or offline.	No
sourceProperties	string	Specifies the source file.	No
security	string	The security section for this input. Array of Users and Groups with their respective permissions for this input object.	No
permissions	string	The permissions section for this input. Array of Users and Groups with their respective permissions for this input object.	No

RenderResult

Name	Type	Description	Required
fitMode	string	The FitMode of the document like FITSCALE	No
outputFormat	string	The output like TIFF	No
rotation	string	The Rotation Stop, example ZERO	No
scaleFactor	int	The scale factor , example = 100	No
pageNumber	int	The page number	No
withAnnotations	boolean	Whether annotations are included or not	No
docPageCount	int	Document page count	No
pages	string array	The array of page numbers	No
mimeType	string	the mime type	No
fileName	string	The file name	No
originalFilename	string	The original file name	No
totalPageCount	int	The total page count of the document	No
document	Document	The document object	No

Rendition

Name	Type	Description	Required
mimeType	string	The mime type of the document.	No
originalFilename	string	The original file name	No
document	Document	The document object	No

Document

Name	Type	Description	Required
id	string	The document id.	Yes
name	string	The name of the document	No
properties	string	The properties section of the document	No
documentpermissions	string	The permissions section of the document. The permissions that the user has on the document.	No
fieldvalues	string	The fieldvalues section of the document. Gives detail of all the fields and the field values for this document.	No

Title and Copyright Information

REST API for Oracle WebCenter Imaging

G16670-02

Last updated: April 2025

Primary Author: Oracle Corporation