API Docs
Rest Integration Profile
Overview
Alma integrates with external systems such as vendor systems, Enterprise Resource Planning systems, catalog systems, remote storage systems, etc. using standard protocols.
Integration profiles define the way an integration is being performed.
Data Dictionary
Click here to download rest_integration_profile.xsd
integration_profile
Description: Integration profile object.
| Field | Type | Description | ||
|---|---|---|---|---|
id | string | Integration profile ID. This ID can be used in order to find the corresponding job ID. For more information see Working with the Alma Jobs API. | ||
code | string | Integration profile code. Mandatory. | ||
name | string | Integration profile name. Mandatory. | ||
type | string with attr. | The integration profile type. Possible codes are listed in 'IntegrationTypes' code table. This field cannot be updated.
| ||
system | string with attr. | The system with which you are integrating (for informational purposes).mandatory. Possible codes are listed in 'ExternalSystemTypes' code table.
| ||
default | boolean | Indication whether the profile is a default profile. Default is false. | ||
system_ | string | Integration profile code. Mandatory. | ||
description | string | Deposit profile description. | ||
parameters | parameters | List of the profile's related parameters. These parameters are parallel to the fields in the "Actions" tab of the integration profile in Alma UI. | ||
contact_ | contact_info | The Integration Profile Contact information. |
parameters
Description:
List of the profile's related parameters.
These parameters are parallel to the fields in the "Actions" tab of the integration profile in Alma UI.
| Field | Type | Description |
|---|---|---|
parameter | parameter | Specific profile's related parameter. |
parameter
Description: Specific job parameter.
| Field | Type | Description |
|---|---|---|
action | string with attr. | The name of the action the specific parameter is related to. |
name | string with attr. | The name of the parameter. |
value | string | The parameter value. |
Samples
XML
JSON
__