API docs by Redocly

INN-Reach Contribution API (v1)

contributions

getCurrentContributionByServerId

Get current INN-Reach contribution for the given central server

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "itemTypeMappingStatus": "Valid",
  • "locationsMappingStatus": "Valid",
  • "status": "In Progress",
  • "contributionStarted": "2019-08-24T14:15:22Z",
  • "contributionStartedBy": "string",
  • "contributionComplete": "2019-08-24T14:15:22Z",
  • "recordsTotal": 0,
  • "recordsProcessed": 0,
  • "recordsContributed": 0,
  • "recordsUpdated": 0,
  • "recordsDecontributed": 0,
  • "errors": [
    ],
  • "metadata": {
    }
}

cancelCurrentContributionByServerId

Cancel current INN-Reach contribution for the given central server

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

getContributionHistoryByServerId

Get a list of Inn-Reach contributions for the given central server

path Parameters
centralServerId
required
string <uuid>
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "contributionHistory": [
    ]
}

startInitialContribution

Start initial contribution process

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}