infor

Business Context

Adds an item to the content repository. Returns a document containing the newly added item. If the "checkout" parameter is set to "true" the new item left in a checked out (locked) state.

Add an item

Returns a string containing the number of items in the search result. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image".

Returns the number of items in the search result based on Business context message.

Returns a document containing a collection of entities based on Business context message.

Returns entities

Returns a document containing all the current business context models

Returns all BusinessContextModels

Returns a document containing a specific BusinessContextModel using the key 'entity:product:screen:docType', also fall backs to a ''(empty string) key in order to support previous versions of the api.

Returns a BusinessContextModel object

Returns a document containing the items matching the Business context message.

Search for items

Returns a model of attribute order related to the given document type.

Retrieve an attribute order.

Returns a document containing the related document items for a given pid.

Retrieve all related documents for a given pid

Updates the specified item resource in the content repository. For uploading large files this Api should be used. The text content of the file (if any) will not be text searchable when this Api is used. If the content repository supports versioning and the revisioning policy for this entity is turned on, the update will result in a new version being created. If "checkout" is set to "true" the item is checked out before the update automatically (if not already checked out) and if "checkin" is set to "true" the item is checked in after the update. Returns a document containing the updated item.

Update an item resource

Returns the specified item's main resource file as a stream.

Retrieves an item's main resource file

Returns an item conversion resource file as a stream.

Retrieves an item's resource file based on conversion name

Configuration

Imports a configuration

Returns a document containing the result list.

Returns the result list document

Connection

Creates a connection to the content repository.

Login

Disconnects the connection to the content repository.

Logout

Returns a document containing a collection of all content repository properties.

Returns all properties

Returns a document containing a specified property.

Returns a property

commit Transaction

rollback Transaction

start Transaction

Validates the current connection to the content repository. This operation can be used to create heartbeat functionality.

Validate

Content Migration

Returns a document containing the items matching the query. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image". Note that it's also possible to call the post method with text/plain as parameter content type (when calling from outside this UI).

Search for items (by string)

Updates the specified item in the content repository. If the content repository supports versioning and the revisioning policy for this entity is turned on, the update will result in a new version being created. If "checkout" is set to "true" the item is checked out before the update automatically (if not already checked out) and if "checkin" is set to "true" the item is checked in after the update. Returns a document containing the updated item.

Update an item

Datamodel

Returns a document containing a collection of all entities.

Returns all entities

Returns a document containing a collection of all entities for a given classification.

Returns all entities for a given classification

Returns a document containing the entity data for the specified entity name.

Returns an entity

Returns all item templates for the entity.

Returns the templates for an entity

Document Output

Get status for all jobs with the same batch id. See Java Doc for more details.

Get status for a submitted job by Document PID. See Java Doc for more details.

Distribution

Get status for a submitted job by Job ID. See Java Doc for more details.

With Document Output it is possible to generate pdf files or Word files from Word templates and distribute to different targets (e-mail, print or idm). It is also possible to merge documents into one pdf or to a Word file if all documents are Word files. For example if generating one document and there is a need to add some shared legal pages at the end (or the beginning) of the document.

Even if Document Output have focused a lot of generating new pdf or Word files, Document Output can be used to just send e-mail or print documents, both existing documents in IDM and document send in to Document Output.

Document Output can also be used for creating and sending e-mails with an HTML body. See Java Doc for more details on how to construct the payload.

Terminate jobs with the specified batchIds or jobIds.

Email

Send Email Message

Retrieve list of template names

Items

Returns the output for each batch operation. The operations are returned in the same order as they were sent to the api.

Execute one or more batch operations

Creates a copy of the specified item. The input document is optional and allows for attributes or file to overriden. Returns a document containing the copied item. If the "checkout" parameter is set to "true" the new item left in a checked out (locked) state.

Copy the latest version of an item

Creates a copy of the specified item. The input document allows for attributes or file to overriden. Returns a document containing the copied item. If the "checkout" parameter is set to "true" the new item left in a checked out (locked) state.

Copy a specific version of an item with default data

Returns a string containing the number of items in the search result. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image".  Note that it's also possible to call the post method with text/plain as parameter content type (when calling from outside this UI).

Returns the number of items in the search result (by string)

Returns a string containing the number of items in the search result. A query is an SearchQueries object in xml or json.

Returns the number of items in the search result (by SearchQueries)

Returns a document containing the items matching the query. A query is an SearchQueries object in xml or json.

Search for items (by SearchQueries)

Returns a document containing an item matching the query. If more than one item matches the query only the first one is returned. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image". Note that it's also possible to call the post method with text/plain as parameter content type (when calling from outside this UI).

Search for one item (by string)

Returns a document containing an item matching the query. If more than one item matches the query only the first one is returned. A query is an SearchQueries object in xml or json.

Search for one item (by SearchQueries)

Returns a document containing the main resource matching the query. If more than one resource matches the query only the first one's main resource is returned. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image".  Note that it's also possible to call the post method with text/plain as parameter content type (when calling from outside this UI).

Search for an item's main resource (by string)

Returns a document containing the main resource matching the query. If more than one resource matches the query only the first one's main resource is returned. A query is an SearchQueries object in xml or json.

Search for an item's main resource (by SearchQueries)

Returns the item's main resource file as a stream. If more than one item matches the query only the first one is returned. A query is an SearchQueries object in xml or json.

Search for the main resource file (by SearchQueries)

Returns a document containing the conversion resource matching the query. If more than one item matches the query only the first one's conversion resource is returned. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image". Note that it's also possible to call the post method with text/plain as parameter content type (when calling from outside this UI).

Search for an item conversion resource (by string)

Returns a document containing the conversion resource matching the query. If more than one item matches the query only the first one's conversion resource is returned. A query is an SearchQueries object in xml or json.

Search for an item conversion resource (by SearchQueries)

Returns the file as a stream. If more than one item matches the query only the first one's conversion resource is returned. An example of a query is /MDS_File[@MDS_Name="MyName"] which returns the items named "MyName" of the document type "MDS_Image". Note that it's also possible to call the post method with text/plain as parameter content type (when calling from outside this UI).

Search for a conversion resource file (by string)

Returns the file as a stream. If more than one item matches the query only the first one's conversion resource is returned. A query is an SearchQueries object in xml or json.

Search for a conversion resource file (by SearchQueries)

A new item will be created from the specified template. Returns a document from the template item. If the "checkout" parameter is set to "true" the new item left in a checked out (locked) state.

Creates a new item from a template

Retrieve an item

Deletes the specified item in the content repository.

Delete an item

Checks in the item. Returns a document containing the updated item.

Check in an item

Checks out the item. Returns a document containing the updated item.

Check out an item

Returns an SerializableDocument with related items matching the Mimetypes specified

Retrieve all pid related documents of compatible mimetype to be stittched

Returns a document containing the specified item's main resource.

Retrieves an item's main resource

Returns a document that contains the item's converison resource.

Retrieves an item's resource data based on conversion name

Undo the check out of the item. Returns a document containing the updated item.

Undo check out of an item

If the content repository supports versioning this operation returns a document containing a collection of all of the specified item's versions.

Retrieves a collection of all versions of a specified item

If the content repository supports versioning this operation returns a document containing the item of the specified version.

Retrieves a specific version of an item

If the content repository supports versioning this operation returns a document containing the specified version of the item's main resource.

Retrieves the main resource of a specific item version

If the content repository supports versioning this operation returns the main resource of the specified item version as a stream.

Retrieves the main resource file of a specific item version

If the content repository supports versioning this operation returns a document containing the conversion resource of the specified item version.

Retrieves the conversion resource of a specific item version

If the content repository supports versioning this operation returns the conversion resource of the specified item version as a stream.

Retrieves the conversion resource file of a specific item version

If the content repository supports versioning this operation reverts the item to the specifed version. A document containing the item is returned.

Reverts to a specific version

Templates

Assembles one or more items into a PDF. The items are specified by the pid parameter.

Assembles one or more items into a PDF

Assembles one or more items into a file based on original file/s mimetype. The input CMItems xml should contain the PIDs of all the documents that should be concatenated into one file.

Assembles one or more items into a single file

Populates the input template file and adds it as a new item in IDM. Returns a document containing the item that was created. The new item is specified with the `item` parameter. For additional details, see the /api/templates/stream method.

Populate a template and add it to IDM

Populates the input template file and adds it as a new item in IDM. Returns the resulting file as a stream. The new item is specified with the `item` parameter. For additional details, see the /api/templates/stream method.

Populates the input template file and adds it to an existing item in IDM. Returns a document containing the updated item. The new item is specified with the `item` parameter. For additional details, see the /api/templates/stream method.

Populate a template and add it to an existing item in IDM

Populates the input template file and adds it to an existing item in IDM. Returns the resulting file as a stream. The new item is specified with the `item` parameter. For additional details, see the /api/templates/stream method.

Populates the input template file and returns the resulting file as a stream. 
# Overview
To populate a template with data it must contain content controls. The data in the content controls will be replaced based on the `data` file or the `templateController` file. These two files provide two different ways to populate the template.

Example files can be found in the Example project that is available for download for both Java and .Net.
## data
The data file is an XML file that will replace the Custom XML Part with the same namespace in the template. Content controls that are mapped to the Custom XML Part will be updated with the data from the XML file based on the Xpath of the elements. Text and base64-encoded images are supported in the XML.
## templateController
The templateController is a JSON/XML file that allows you to control specific content controls. Mapping to content controls are done using the `tag` attribute that must match the tag of the content control.
 Available attributes:
* `text` - Sets the text of the content control. If carriage returns are allowed on the control, new lines can be inserted with `\n`
* `visible` - Hides the content control and its contents if set to `true`
* `imageBase64` - Replaces the content of an image content control with this base64-encoded image 

# Watermark
A watermark text can be inserted into the document that will be visible in the center of all pages. This is done by defining the `watermark` element in the templateController file. The following attributes are available in the watermark element:
  * `text` - Required. Defines the text of the watermark
  * `color` - Defines the color of the watermark using the values (0-255) of the child elements: `red`, `green` and `blue`
  * `fontSize` - The font size of the watermark text
  * `fontFamily` - The font family of the watermark text
  * `textRotation` - The clockwise rotation of the watermark text (degrees)

# Template input
The template is a .docx file that can be specified using one of these three parameter options:
* `template` - An external file. Upload the template file using the browse button.
* `$pid` - If the template is already stored in IDM the pid of a template can be used as a reference.
* `$templateEntityName AND $templateName` - If the template is already stored in IDM the entity name and name of the template can be used as a reference

# Images
It's possible to change the image of an image content control by sending an image file in the form-data. The name of the form field must match the tag of the content control.
# Output formats
The output format is specified by the `$mimetype` parameter, or the extension in the `$filename` parameter if no mimetype is specified. If none of these parameters are specified the default extension `.docx` will be used. Available file extensions (and corresponding mimetype):
* `.docx (application/vnd.openxmlformats-officedocument.wordprocessingml.document)`
* `.doc (application/msword)`
* `.pdf (application/pdf)`
* `.odt (application/vnd.oasis.opendocument.text)`
* `.rtf (application/rtf)`
* `.txt (text/plain)`
* `.jpg (image/jpeg)`
* `.png (image/png)`


Populate a template

Signature V1

Retrieve access token through authorization code by using OAuth2 method.

Retrieve OAuth2 authorization token.

Authorization in digital signature service by using OAuth2 method.

Digital signature authorization using OAuth2 method.

Send envelope of Documents to digital signature service.

Digital signature service send envelope.

Retrieve detailed information by ID of the envelope from digital signature service.

Digital signature service retrieve detailed envelope information.

Cancel signing process of the envelope by the given ID and release current version of IDM document.

Digital signature service cancel the envelope signing process.

Retrieve envelope resources by ID of the envelope from digital signature service.

Digital signature service retrieve envelope resources for completed envelope.

Retrieve the list of envelopes by document PID from digital signature service.

Digital signature service list of created envelopes.

Retrieve list of Templates from digital signature service.

Digital signature service Templates list.

Retrieve detailed information of Template from digital signature service.

Digital signature service Template information.

Retrieve users by name fragment or email from digital signature service.

Digital signature service retrieve users by name fragment or email.

User Analytics

Retrieve Access key and Refresh Token from QuickSight

Get the Access key and Refresh Token from QuickSight

Default

Infor API | Api

Language parameter, for example 'en' or 'en-US'. Enables localized error messages.

$language

DocuSign authorization Code form authentication service

code

The State parameter which provided in the initial request

state

Bad Request

Unauthorized

Forbidden

Internal Server Error

items

recipients

subject

message

Set to [true], if you want to have the edit view URL in response.

edit

Identifier of the envelope for retrieve detailed information.

Identifier of the envelope for retrieving resource files.

PID of the document for retrieve list of envelopes.

Identifier of template for retrieve detailed information.

A fragment of either or both of the first name or last name of the user.

Sections