http://localhost
API for managing data import profiles
Create a new jobProfile item.
POST /data-import-profiles/jobProfiles
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Job Profile name",
"type": "string"
},
"description": {
"description": "Job Profile description",
"type": "string"
},
"dataTypes": {
"description": "Set of data types",
"type": "array",
"items": {
"type": "object",
"$ref": "../common/dataType.json"
}
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "448ae575-daec-49c1-8041-d64c8ed8e5b1",
"name": "Load vendor order records",
"description": "Ordered on vendor site; load MARC to create bib, holdings, item, and order; keep MARC",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "daily"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:41:22.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-02T12:09:51.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created jobProfile item
Media type: application/json
Type: any
Example:
{
"id": "448ae575-daec-49c1-8041-d64c8ed8e5b1",
"name": "Load vendor order records",
"description": "Ordered on vendor site; load MARC to create bib, holdings, item, and order; keep MARC",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "daily"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:41:22.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-02T12:09:51.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to add jobProfile -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create jobProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve a list of jobProfile items.
GET /data-import-profiles/jobProfiles
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example userInfo.lastName=Doe
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
userInfo.lastName=Doe
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
Requested language. Optional. [lang=en]
Returns a list of jobProfile items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of Job Profiles",
"type": "object",
"properties": {
"jobProfiles": {
"description": "List of Job Profiles",
"type": "array",
"id": "jobProfileList",
"items": {
"type": "object",
"$ref": "jobProfile.json"
}
},
"totalRecords": {
"description": "Total number of Job Profiles",
"type": "integer"
}
},
"required": [
"jobProfiles",
"totalRecords"
]
}
Example:
{
"jobProfiles": [
{
"id": "448ae575-daec-49c1-8041-d64c8ed8e5b1",
"name": "Load vendor order records",
"description": "Ordered on vendor site; load MARC to create bib, holdings, item, and order; keep MARC",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "daily"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:41:22.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-02T12:09:51.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "295e28b4-aea2-4458-9073-385a31e1da05",
"name": "Load shelfready cataloging records",
"description": "Overlay brief bibs, update holdings and item records, create invoice",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"cat", "weekly"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:42:18.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-03T10:01:30.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "bb689511-5365-4050-8084-a03d94728d88",
"name": "Approval plan records",
"description": "Create bibs, holdings, items, orders, and invoices",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "cat", "weekly"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:45:33.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-03T11:22:30.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "3e705998-9169-4f31-b048-90ffdcbd24c1",
"name": "Load KB eResource records",
"description": "Create, update, delete existing eContent bib records",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"monthly", "KB"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-01T10:12:51.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-02T09:05:30.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "15426802-bb0d-4dfb-8eee-90f64fed0cf1",
"name": "ETL Bib records",
"description": "Reload bib records that were exported and updated outside of FOLIO",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": []
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-01T10:37:53.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-03T11:45:21.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "87e4ad58-d677-43dd-8b04-9795741b2103",
"name": "Loading authority records",
"description": "Load new and updated MARC authority records",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"cat", "monthly"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-02T10:20:32.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-02T10:45:21.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "72af7eb7-d7e2-4d16-93ac-682b9a58a94c",
"name": "DDA discovery records",
"description": "Load DDA discovery MARC records to create bib and holdings",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"weekly", "DDA"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-02T10:18:44.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-03T14:20:21.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "4d1b5024-2c49-42bd-b781-4330d14cefb0",
"name": "Create orders from spreadsheets",
"description": "Selector-provided spreadsheet creates instance, holdings, item, and order",
"dataTypes": [
"Delimited"
],
"tags": {
"tagList": [
"acq"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-01T10:09:51.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-01T15:21:28.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "b32e79bc-01d9-4d31-bc08-a3621fcfc1aa",
"name": "Load EDI Invoice",
"description": "",
"dataTypes": [
"EDIFACT"
],
"tags": {
"tagList": [
"acq"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-01T10:18:42.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-05T13:08:12.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
},
{
"id": "828a787c-bcf3-4c28-891a-9e6f3ba5068b",
"name": "Load MARC, then throw away",
"description": "Ordered on vendor site; load MARC to create bib, holdings, item, and order; then discard MARC",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "daily"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-11-01T11:08:21.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-12-01T19:01:41.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
],
"totalRecords": 10
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to list jobProfiles -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list jobProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Update jobProfile item with given {jobProfileId}
PUT /data-import-profiles/jobProfiles/{id}
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Job Profile name",
"type": "string"
},
"description": {
"description": "Job Profile description",
"type": "string"
},
"dataTypes": {
"description": "Set of data types",
"type": "array",
"items": {
"type": "object",
"$ref": "../common/dataType.json"
}
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "448ae575-daec-49c1-8041-d64c8ed8e5b1",
"name": "Load vendor order records",
"description": "Ordered on vendor site; load MARC to create bib, holdings, item, and order; keep MARC",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "daily"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:41:22.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-02T12:09:51.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Job Profile name",
"type": "string"
},
"description": {
"description": "Job Profile description",
"type": "string"
},
"dataTypes": {
"description": "Set of data types",
"type": "array",
"items": {
"type": "object",
"$ref": "../common/dataType.json"
}
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to update jobProfile -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"jobProfile not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete jobProfile item with given {jobProfileId}
DELETE /data-import-profiles/jobProfiles/{id}
Requested language. Optional. [lang=en]
Item deleted successfully
Media type: text/plain
Type: any
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to delete jobProfile -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"jobProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve jobProfile item with given {jobProfileId}
GET /data-import-profiles/jobProfiles/{id}
Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Job Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Job Profile name",
"type": "string"
},
"description": {
"description": "Job Profile description",
"type": "string"
},
"dataTypes": {
"description": "Set of data types",
"type": "array",
"items": {
"type": "object",
"$ref": "../common/dataType.json"
}
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "448ae575-daec-49c1-8041-d64c8ed8e5b1",
"name": "Load vendor order records",
"description": "Ordered on vendor site; load MARC to create bib, holdings, item, and order; keep MARC",
"dataTypes": [
"MARC"
],
"tags": {
"tagList": [
"acq", "daily"
]
},
"userInfo": {
"firstName": "DIKU",
"lastName": "ADMINISTRATOR",
"userName": "diku_admin"
},
"metadata": {
"createdDate": "2018-10-30T12:41:22.000",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2018-11-02T12:09:51.000",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"jobProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a new matchProfile item.
POST /data-import-profiles/matchProfiles
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Match Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Match Profile name",
"type": "string"
},
"description": {
"description": "Match Profile description",
"type": "string"
},
"match": {
"description": "Order info",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Match Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Match Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"match": "Order 998",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created matchProfile item
Media type: application/json
Type: any
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"match": "Order 998",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to add matchProfile -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create matchProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve a list of matchProfile items.
GET /data-import-profiles/matchProfiles
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example userInfo.lastName=Doe
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
userInfo.lastName=Doe
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
Requested language. Optional. [lang=en]
Returns a list of matchProfile items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of Match Profiles",
"type": "object",
"properties": {
"matchProfiles": {
"description": "List of Match Profiles",
"type": "array",
"id": "matchProfileList",
"items": {
"type": "object",
"$ref": "matchProfile.json"
}
},
"totalRecords": {
"description": "Total number of Match Profiles",
"type": "integer"
}
},
"required": [
"matchProfiles",
"totalRecords"
]
}
Example:
{
"matchProfiles": [
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"match": "Order 998",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
],
"totalRecords": 1
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to list matchProfiles -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list matchProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Update matchProfile item with given {matchProfileId}
PUT /data-import-profiles/matchProfiles/{id}
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Match Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Match Profile name",
"type": "string"
},
"description": {
"description": "Match Profile description",
"type": "string"
},
"match": {
"description": "Order info",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Match Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Match Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"match": "Order 998",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Match Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Match Profile name",
"type": "string"
},
"description": {
"description": "Match Profile description",
"type": "string"
},
"match": {
"description": "Order info",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Match Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Match Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to update matchProfile -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"matchProfile not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete matchProfile item with given {matchProfileId}
DELETE /data-import-profiles/matchProfiles/{id}
Requested language. Optional. [lang=en]
Item deleted successfully
Media type: text/plain
Type: any
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to delete matchProfile -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"matchProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve matchProfile item with given {matchProfileId}
GET /data-import-profiles/matchProfiles/{id}
Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Match Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Match Profile name",
"type": "string"
},
"description": {
"description": "Match Profile description",
"type": "string"
},
"match": {
"description": "Order info",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Match Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Match Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"match": "Order 998",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"matchProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a new mappingProfile item.
POST /data-import-profiles/mappingProfiles
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Mapping Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Mapping Profile name",
"type": "string"
},
"description": {
"description": "Mapping Profile description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Profile for mapping",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"description": "Description for mapping profile",
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
},
"metadata": {
"createdDate": "2019-01-01T11:550:09Z",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2019-01-12T14:21:11Z",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created mappingProfile item
Media type: application/json
Type: any
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Profile for mapping",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"description": "Description for mapping profile",
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
},
"metadata": {
"createdDate": "2019-01-01T11:550:09Z",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2019-01-12T14:21:11Z",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to add mappingProfile -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create mappingProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve a list of mappingProfile items.
GET /data-import-profiles/mappingProfiles
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example userInfo.lastName=Doe
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
userInfo.lastName=Doe
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
Requested language. Optional. [lang=en]
Returns a list of mappingProfile items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of Mapping Profiles",
"type": "object",
"properties": {
"mappingProfiles": {
"description": "List of Mapping Profiles",
"type": "array",
"id": "mappingProfileList",
"items": {
"type": "object",
"$ref": "mappingProfile.json"
}
},
"totalRecords": {
"description": "Total number of Mapping Profiles",
"type": "integer"
}
},
"required": [
"mappingProfiles",
"totalRecords"
]
}
Example:
{
"mappingProfiles": [
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Profile for mapping",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"description": "Description for mapping profile",
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
},
"metadata": {
"createdDate": "2019-01-01T11:550:09Z",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2019-01-12T14:21:11Z",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
],
"totalRecords": 1
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to list mappingProfiles -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list mappingProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Update mappingProfile item with given {mappingProfileId}
PUT /data-import-profiles/mappingProfiles/{id}
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Mapping Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Mapping Profile name",
"type": "string"
},
"description": {
"description": "Mapping Profile description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Profile for mapping",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"description": "Description for mapping profile",
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
},
"metadata": {
"createdDate": "2019-01-01T11:550:09Z",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2019-01-12T14:21:11Z",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Mapping Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Mapping Profile name",
"type": "string"
},
"description": {
"description": "Mapping Profile description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to update mappingProfile -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"mappingProfile not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete mappingProfile item with given {mappingProfileId}
DELETE /data-import-profiles/mappingProfiles/{id}
Requested language. Optional. [lang=en]
Item deleted successfully
Media type: text/plain
Type: any
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to delete mappingProfile -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"mappingProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve mappingProfile item with given {mappingProfileId}
GET /data-import-profiles/mappingProfiles/{id}
Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Mapping Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Mapping Profile name",
"type": "string"
},
"description": {
"description": "Mapping Profile description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Job Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Job Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Profile for mapping",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"description": "Description for mapping profile",
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
},
"metadata": {
"createdDate": "2019-01-01T11:550:09Z",
"createdByUserId": "",
"createdByUsername": "",
"updatedDate": "2019-01-12T14:21:11Z",
"updatedByUserId": "",
"updatedByUsername": ""
}
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"mappingProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Create a new actionProfile item.
POST /data-import-profiles/actionProfiles
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Action Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Action Profile name",
"type": "string"
},
"description": {
"description": "Action Profile description",
"type": "string"
},
"action": {
"description": "Action description",
"type": "string"
},
"mapping": {
"description": "Mapping description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Action Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Action Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"action": "Create order",
"mapping": "EDI orders",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Returns a newly created item, with server-controlled fields like 'id' populated
URI to the created actionProfile item
Media type: application/json
Type: any
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"action": "Create order",
"mapping": "EDI orders",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to add actionProfile -- malformed JSON at 13:3"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to create actionProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve a list of actionProfile items.
GET /data-import-profiles/actionProfiles
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example userInfo.lastName=Doe
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
userInfo.lastName=Doe
Skip over a number of elements by specifying an offset value for the query
Example:
0
Limit the number of elements returned in the response
Example:
10
Requested language. Optional. [lang=en]
Returns a list of actionProfile items
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Collection of Action Profiles",
"type": "object",
"properties": {
"actionProfiles": {
"description": "List of Action Profiles",
"type": "array",
"id": "actionProfileList",
"items": {
"type": "object",
"$ref": "actionProfile.json"
}
},
"totalRecords": {
"description": "Total number of Action Profiles",
"type": "integer"
}
},
"required": [
"actionProfiles",
"totalRecords"
]
}
Example:
{
"actionProfiles": [
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"action": "Create order",
"mapping": "EDI orders",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
],
"totalRecords": 1
}
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
unable to list actionProfiles -- malformed parameter 'query', syntax error at column 6
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to list actionProfiles -- unauthorized
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Update actionProfile item with given {actionProfileId}
PUT /data-import-profiles/actionProfiles/{id}
Requested language. Optional. [lang=en]
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Action Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Action Profile name",
"type": "string"
},
"description": {
"description": "Action Profile description",
"type": "string"
},
"action": {
"description": "Action description",
"type": "string"
},
"mapping": {
"description": "Mapping description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Action Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Action Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"action": "Create order",
"mapping": "EDI orders",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Action Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Action Profile name",
"type": "string"
},
"description": {
"description": "Action Profile description",
"type": "string"
},
"action": {
"description": "Action description",
"type": "string"
},
"mapping": {
"description": "Mapping description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Action Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Action Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Item successfully updated
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to update actionProfile -- malformed JSON at 13:4"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"actionProfile not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A set of errors",
"type": "object",
"properties": {
"errors": {
"description": "List of errors",
"id": "errors",
"type": "array",
"items": {
"type": "object",
"$ref": "error.schema"
}
},
"total_records": {
"type": "integer"
}
}
}
Example:
{
"errors": [
{
"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [
{
"key": "moduleTo",
"value": "null"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
Delete actionProfile item with given {actionProfileId}
DELETE /data-import-profiles/actionProfiles/{id}
Requested language. Optional. [lang=en]
Item deleted successfully
Media type: text/plain
Type: any
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Media type: text/plain
Type: any
Example:
"unable to delete actionProfile -- constraint violation"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"actionProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator
Retrieve actionProfile item with given {actionProfileId}
GET /data-import-profiles/actionProfiles/{id}
Requested language. Optional. [lang=en]
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Action Profile schema",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier",
"type": "string"
},
"name": {
"description": "Action Profile name",
"type": "string"
},
"description": {
"description": "Action Profile description",
"type": "string"
},
"action": {
"description": "Action description",
"type": "string"
},
"mapping": {
"description": "Mapping description",
"type": "string"
},
"tags": {
"description": "Set of tags assigned to the current Action Profile",
"type": "object",
"$ref": "../../raml-util/schemas/tags.schema"
},
"userInfo": {
"description": "First name, last name and username of the user, who updated the Action Profile",
"type": "object",
"$ref": "../common/userInfo.json"
},
"metadata": {
"description": "Metadata provided by the server",
"type": "object",
"$ref": "../../raml-util/schemas/metadata.schema",
"readonly": true
}
},
"required": [
"name"
]
}
Example:
{
"id": "1kl9m60r-fvb7-45n0-23c0-13n8gbkl7091",
"name": "Dolor sit",
"description": "Lorem ipsum dolor sit amet",
"action": "Create order",
"mapping": "EDI orders",
"tags": {
"tagList": [
"lorem", "ipsum", "dolor"
]
},
"userInfo": {
"firstName": "Jane",
"lastName": "Doe",
"userName": "@janedoe"
}
}
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"actionProfile not found"
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator