Infor API | Api

Infor API | Api

## Sections
• [Add an item](https://developer.infor.com/api/business-context/add-an-item.md): 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.
• [Returns the number of items in the search result based on Business context message.](https://developer.infor.com/api/business-context/returns-the-number-of-items-in-the-search-result-based-on-business-context-message.md): 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 entities](https://developer.infor.com/api/business-context/returns-entities.md): Returns a document containing a collection of entities based on Business context message.
• [Returns all BusinessContextModels](https://developer.infor.com/api/business-context/returns-all-businesscontextmodels.md): Returns a document containing all the current business context models
• [Returns a BusinessContextModel object](https://developer.infor.com/api/business-context/returns-a-businesscontextmodel-object.md): 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.
• [Search for items](https://developer.infor.com/api/business-context/search-for-items.md): Returns a document containing the items matching the Business context message.
• [Retrieve an attribute order.](https://developer.infor.com/api/business-context/retrieve-an-attribute-order.md): Returns a model of attribute order related to the given document type.
• [Retrieve all related documents for a given pid](https://developer.infor.com/api/business-context/retrieve-all-related-documents-for-a-given-pid.md): Returns a document containing the related document items for a given pid.
• [Update an item resource](https://developer.infor.com/api/business-context/update-an-item-resource.md): 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.
• [Retrieves an item's main resource file](https://developer.infor.com/api/business-context/retrieves-an-item-s-main-resource-file.md): Returns the specified item's main resource file as a stream.
• [Retrieves an item's resource file based on conversion name](https://developer.infor.com/api/business-context/retrieves-an-item-s-resource-file-based-on-conversion-name.md): Returns an item conversion resource file as a stream.
• [Imports a configuration](https://developer.infor.com/api/configuration/imports-a-configuration.md): Import a configuration document.
• [Returns the result list document](https://developer.infor.com/api/configuration/returns-the-result-list-document.md): Returns a document containing the result list.
• [Returns the result list document](https://developer.infor.com/api/configuration/returns-the-result-list-document-1.md): Returns a document containing the result list.
• [Login](https://developer.infor.com/api/connection/login.md): Creates a connection to the content repository.
• [Logout](https://developer.infor.com/api/connection/logout.md): Disconnects the connection to the content repository.
• [Returns all properties](https://developer.infor.com/api/connection/returns-all-properties.md): Returns a document containing a collection of all content repository properties.
• [Returns a property](https://developer.infor.com/api/connection/returns-a-property.md): Returns a document containing a specified property.
• [commit Transaction](https://developer.infor.com/api/connection/commit-transaction.md)
• [rollback Transaction](https://developer.infor.com/api/connection/rollback-transaction.md)
• [start Transaction](https://developer.infor.com/api/connection/start-transaction.md)
• [Validate](https://developer.infor.com/api/connection/validate.md): Validates the current connection to the content repository. This operation can be used to create heartbeat functionality.
• [Add an item](https://developer.infor.com/api/content-migration/add-an-item-1.md): 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.
• [Search for items (by string)](https://developer.infor.com/api/content-migration/search-for-items-by-string.md): 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).
• [Update an item](https://developer.infor.com/api/content-migration/update-an-item.md): 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.
• [Retrieves an item's main resource file](https://developer.infor.com/api/content-migration/retrieves-an-item-s-main-resource-file-1.md): Returns the specified item's main resource file as a stream.
• [Returns all entities](https://developer.infor.com/api/datamodel/returns-all-entities.md): Returns a document containing a collection of all entities.
• [Returns all entities for a given classification](https://developer.infor.com/api/datamodel/returns-all-entities-for-a-given-classification.md): Returns a document containing a collection of all entities for a given classification.
• [Returns an entity](https://developer.infor.com/api/datamodel/returns-an-entity.md): Returns a document containing the entity data for the specified entity name.
• [Returns the templates for an entity](https://developer.infor.com/api/datamodel/returns-the-templates-for-an-entity.md): Returns all item templates for the entity.
• [Document Output](https://developer.infor.com/api/document-output/document-output-1.md): Get status for all jobs with the same batch id. See Java Doc for more details.
• [Document Output](https://developer.infor.com/api/document-output/document-output-2.md): Get status for a submitted job.
• [Distribution](https://developer.infor.com/api/document-output/distribution.md): Get status for a submitted job by Document PID. See Java Doc for more details.
• [Document Output](https://developer.infor.com/api/document-output/document-output-3.md): Get status for a submitted job by Job ID. See Java Doc for more details.
• [Document Output](https://developer.infor.com/api/document-output/document-output-4.md): 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.
• [Document Output](https://developer.infor.com/api/document-output/document-output-5.md): Terminate jobs with the specified batchIds or jobIds.
• [Send Email Message](https://developer.infor.com/api/email/send-email-message.md): Sends Email with attachment.
• [Retrieve list of template names](https://developer.infor.com/api/email/retrieve-list-of-template-names.md): Retrieve list of template names
• [Add an item](https://developer.infor.com/api/items/add-an-item-2.md): 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.
• [Execute one or more batch operations](https://developer.infor.com/api/items/execute-one-or-more-batch-operations.md): Returns the output for each batch operation. The operations are returned in the same order as they were sent to the api.
• [Copy the latest version of an item](https://developer.infor.com/api/items/copy-the-latest-version-of-an-item.md): 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 a specific version of an item with default data](https://developer.infor.com/api/items/copy-a-specific-version-of-an-item-with-default-data.md): 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.
• [Returns the number of items in the search result (by string)](https://developer.infor.com/api/items/returns-the-number-of-items-in-the-search-result-by-string.md): 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 SearchQueries)](https://developer.infor.com/api/items/returns-the-number-of-items-in-the-search-result-by-searchqueries.md): Returns a string containing the number of items in the search result. A query is an SearchQueries object in xml or json.
• [Search for items (by string)](https://developer.infor.com/api/items/search-for-items-by-string-1.md): 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 SearchQueries)](https://developer.infor.com/api/items/search-for-items-by-searchqueries.md): Returns a document containing the items matching the query. A query is an SearchQueries object in xml or json.
• [Search for one item (by string)](https://developer.infor.com/api/items/search-for-one-item-by-string.md): 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 SearchQueries)](https://developer.infor.com/api/items/search-for-one-item-by-searchqueries.md): 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 an item's main resource (by string)](https://developer.infor.com/api/items/search-for-an-item-s-main-resource-by-string.md): 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 SearchQueries)](https://developer.infor.com/api/items/search-for-an-item-s-main-resource-by-searchqueries.md): 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 the main resource file (by SearchQueries)](https://developer.infor.com/api/items/search-for-the-main-resource-file-by-searchqueries.md): 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 an item conversion resource (by string)](https://developer.infor.com/api/items/search-for-an-item-conversion-resource-by-string.md): 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 SearchQueries)](https://developer.infor.com/api/items/search-for-an-item-conversion-resource-by-searchqueries.md): 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 a conversion resource file (by string)](https://developer.infor.com/api/items/search-for-a-conversion-resource-file-by-string.md): 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 SearchQueries)](https://developer.infor.com/api/items/search-for-a-conversion-resource-file-by-searchqueries.md): 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.
• [Creates a new item from a template](https://developer.infor.com/api/items/creates-a-new-item-from-a-template.md): 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.
• [Retrieve an item](https://developer.infor.com/api/items/retrieve-an-item.md): Returns a document containing the item.
• [Update an item](https://developer.infor.com/api/items/update-an-item-1.md): 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.
• [Delete an item](https://developer.infor.com/api/items/delete-an-item.md): Deletes the specified item in the content repository.
• [Check in an item](https://developer.infor.com/api/items/check-in-an-item.md): Checks in the item. Returns a document containing the updated item.
• [Check out an item](https://developer.infor.com/api/items/check-out-an-item.md): Checks out the item. Returns a document containing the updated item.
• [Retrieve all related documents for a given pid](https://developer.infor.com/api/items/retrieve-all-related-documents-for-a-given-pid-1.md): Returns a document containing the related document items for a given pid.
• [Retrieve all pid related documents of compatible mimetype to be stittched](https://developer.infor.com/api/items/retrieve-all-pid-related-documents-of-compatible-mimetype-to-be-stittched.md): Returns an SerializableDocument with related items matching the Mimetypes specified
• [Retrieves an item's main resource](https://developer.infor.com/api/items/retrieves-an-item-s-main-resource.md): Returns a document containing the specified item's main resource.
• [Update an item resource](https://developer.infor.com/api/items/update-an-item-resource-1.md): 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.
• [Retrieves an item's main resource file](https://developer.infor.com/api/items/retrieves-an-item-s-main-resource-file-2.md): Returns the specified item's main resource file as a stream.
• [Retrieves an item's resource data based on conversion name](https://developer.infor.com/api/items/retrieves-an-item-s-resource-data-based-on-conversion-name.md): Returns a document that contains the item's converison resource.
• [Retrieves an item's resource file based on conversion name](https://developer.infor.com/api/items/retrieves-an-item-s-resource-file-based-on-conversion-name-1.md): Returns an item conversion resource file as a stream.
• [Undo check out of an item](https://developer.infor.com/api/items/undo-check-out-of-an-item.md): Undo the check out of the item. Returns a document containing the updated item.
• [Retrieves a collection of all versions of a specified item](https://developer.infor.com/api/items/retrieves-a-collection-of-all-versions-of-a-specified-item.md): If the content repository supports versioning this operation returns a document containing a collection of all of the specified item's versions.
• [Retrieves a specific version of an item](https://developer.infor.com/api/items/retrieves-a-specific-version-of-an-item.md): If the content repository supports versioning this operation returns a document containing the item of the specified version.
• [Retrieves the main resource of a specific item version](https://developer.infor.com/api/items/retrieves-the-main-resource-of-a-specific-item-version.md): 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 file of a specific item version](https://developer.infor.com/api/items/retrieves-the-main-resource-file-of-a-specific-item-version.md): If the content repository supports versioning this operation returns the main resource of the specified item version as a stream.
• [Retrieves the conversion resource of a specific item version](https://developer.infor.com/api/items/retrieves-the-conversion-resource-of-a-specific-item-version.md): If the content repository supports versioning this operation returns a document containing the conversion resource of the specified item version.
• [Retrieves the conversion resource file of a specific item version](https://developer.infor.com/api/items/retrieves-the-conversion-resource-file-of-a-specific-item-version.md): If the content repository supports versioning this operation returns the conversion resource of the specified item version as a stream.
• [Reverts to a specific version](https://developer.infor.com/api/items/reverts-to-a-specific-version.md): If the content repository supports versioning this operation reverts the item to the specifed version. A document containing the item is returned.
• [Assembles one or more items into a PDF](https://developer.infor.com/api/templates/assembles-one-or-more-items-into-a-pdf.md): Assembles one or more items into a PDF. The items are specified by the pid parameter.
• [Assembles one or more items into a single file](https://developer.infor.com/api/templates/assembles-one-or-more-items-into-a-single-file.md): 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.
• [Populate a template and add it to IDM](https://developer.infor.com/api/templates/populate-a-template-and-add-it-to-idm.md): 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](https://developer.infor.com/api/templates/populate-a-template-and-add-it-to-idm-1.md): 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.
• [Populate a template and add it to an existing item in IDM](https://developer.infor.com/api/templates/populate-a-template-and-add-it-to-an-existing-item-in-idm.md): 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](https://developer.infor.com/api/templates/populate-a-template-and-add-it-to-an-existing-item-in-idm-1.md): 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.
• [Populate a template](https://developer.infor.com/api/templates/populate-a-template.md): 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)`
• [Retrieve OAuth2 authorization token.](https://developer.infor.com/api/signature-v1/retrieve-oauth2-authorization-token.md): Retrieve access token through authorization code by using OAuth2 method.
• [Digital signature authorization using OAuth2 method.](https://developer.infor.com/api/signature-v1/digital-signature-authorization-using-oauth2-method.md): Authorization in digital signature service by using OAuth2 method.
• [Digital signature service send envelope.](https://developer.infor.com/api/signature-v1/digital-signature-service-send-envelope.md): Send envelope of Documents to digital signature service.
• [Digital signature service retrieve detailed envelope information.](https://developer.infor.com/api/signature-v1/digital-signature-service-retrieve-detailed-envelope-information.md): Retrieve detailed information by ID of the envelope from digital signature service.
• [Digital signature service cancel the envelope signing process.](https://developer.infor.com/api/signature-v1/digital-signature-service-cancel-the-envelope-signing-process.md): Cancel signing process of the envelope by the given ID and release current version of IDM document.
• [Digital signature service retrieve envelope resources for completed envelope.](https://developer.infor.com/api/signature-v1/digital-signature-service-retrieve-envelope-resources-for-completed-envelope.md): Retrieve envelope resources by ID of the envelope from digital signature service.
• [Digital signature service list of created envelopes.](https://developer.infor.com/api/signature-v1/digital-signature-service-list-of-created-envelopes.md): Retrieve the list of envelopes by document PID from digital signature service.
• [Digital signature service Templates list.](https://developer.infor.com/api/signature-v1/digital-signature-service-templates-list.md): Retrieve list of Templates from digital signature service.
• [Digital signature service Template information.](https://developer.infor.com/api/signature-v1/digital-signature-service-template-information.md): Retrieve detailed information of Template from digital signature service.
• [Digital signature service retrieve users by name fragment or email.](https://developer.infor.com/api/signature-v1/digital-signature-service-retrieve-users-by-name-fragment-or-email.md): Retrieve users by name fragment or email from digital signature service.
• [Get the Access key and Refresh Token from QuickSight](https://developer.infor.com/api/user-analytics/get-the-access-key-and-refresh-token-from-quicksight.md): Retrieve Access key and Refresh Token from QuickSight