Admin imports

5 operations.

GET/api/v1/admin/imports

Import jobs

AdminBeta: may change

Status, progress, result and errors of each job, and the provider syncs that can run.

SDK: collector.listAdminImports()
Key scopes: admin:ops:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`status`optional	query	enum	Which items (default all).One of `all`, `active`, `failed`, `succeeded`default "all"

Responses

200Jobs, newest first.
AdminImportPage
- jobsarray of AdminImportJobrequired
- syncsarray of objectrequired
  Fields of syncs
  id"new_releases" or "releases" or "refresh"required
  Fields of id
  Option 1: "new_releases"
  Option 2: "releases"
  Option 3: "refresh"
  labelstringrequired
  descriptionstringrequired
  availablebooleanrequired
  reasonstring or nullrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/imports' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.listAdminImports({ query: { … } });

GET/api/v1/admin/imports/conflicts

Import identity conflicts

AdminBeta: may change

Provider series left out because another series of that provider holds their identity.

SDK: collector.listAdminImportConflicts()
Key scopes: admin:ops:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`status`optional	query	enum	Which items (default open).One of `open`, `resolved`default "open"

Responses

200Conflicts.
AdminImportConflictPage
- conflictsarray of AdminImportConflictrequired
- countsobjectrequired
  Fields of counts
  opennumberrequired
  resolvednumberrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/imports/conflicts' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.listAdminImportConflicts({ query: { … } });

GET/api/v1/admin/imports/conflicts/{id}

One import conflict in full

AdminBeta: may change

Both series side by side, their issues aligned by number, and what each resolution would do.

SDK: collector.getAdminImportConflict()
Key scopes: admin:ops:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Responses

200The conflict.
AdminImportConflictDetail
- idstringrequired
- providerstringrequired
- externalIdstringrequired
- statusImportConflictStatusrequired
- reasonstring or nullrequired
- lookupConflictProviderLookuprequired
- incomingAdminConflictSeriesFactsrequired
- existingany or nullrequired
- issuesarray of AdminConflictAlignedIssuerequired
- issuesTotalnumberrequired
- impactobjectrequired
  Fields of impact
  mergeAdminConflictMergeImpactrequired
  importobjectrequired
  Fields of import
  baseTitlestringrequired
  issuesnumber or nullrequired
  editionsnumber or nullrequired
  dismissobjectrequired
  Fields of dismiss
  issuesnumber or nullrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (404, 500)

404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/admin/imports/conflicts/<id>' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.getAdminImportConflict({ path: { id } });

POST/api/v1/admin/imports/conflicts/{id}

Resolve an import conflict

AdminBeta: may change

Merge the provider series into the series it collides with, import it as its own series under a disambiguating title, or leave it out. Audited.

SDK: collector.resolveAdminImportConflict()
Key scopes: admin:imports:write(API keys are coming soon)
Headers: X-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Request body (required, application/json)

object or object or object

Option 1: object
- action"merge"required
- notestringoptionalat most 1000 characters
Option 2: object
- action"import"required
- suffixstringrequired1–60 characters
- notestringoptionalat most 1000 characters
Option 3: object
- action"dismiss"required
- notestringrequired3–1000 characters

Responses

200How it was resolved.
object
- statusImportConflictStatusrequired
- seriesIdstring or nullrequired

Errors (400, 404, 409, 500)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409already_resolved invalid_record
already_resolved: Someone already resolved it.
invalid_record: The conflict has no title to import under.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/admin/imports/conflicts/<id>' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.resolveAdminImportConflict({ path: { id }, body: { … } });

POST/api/v1/admin/imports/sync

Start a Metron sync now

AdminBeta: may change

The same jobs the daily crons run; the work continues after the response. One Metron sync at a time.

SDK: collector.startAdminSync()
Key scopes: admin:imports:write(API keys are coming soon)
Headers: X-Request-Id

Request body (required, application/json)

object

jobenumrequired
One ofnew_releasesreleasesrefresh

Responses

200Started.
object
- started"true"required

Errors (400, 404, 409, 500)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
404not_found
not_found: Not an admin (moderator): the same 404 as a missing route.
409sync_running provider_not_configured
sync_running: A Metron sync is already running.
provider_not_configured: Metron credentials aren’t configured.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/admin/imports/sync' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.startAdminSync({ body: { … } });