Imports

List a custom field import's rows

Lists the import's rows in submission order, cursor-paginated, each with its outcome. status narrows the list — ?status=failed after completion is the usual read — and each failed row carries a problem in the same shape the PATCH /projects/{projectId}/custom-fields error response would have had, minus request_id.

Submitted values are not echoed back; index identifies the row by its position in the array you sent.

Requires the permission to view project settings, as reading the import itself does.

get/imports/custom-fields/{importId}/rows

Request

  • Base URL: https://api.rabbet.com/v1
  • URL: https://api.rabbet.com/v1/imports/custom-fields/{importId}/rows
  • Auth: OAuth 2 (client credentials, token URL https://api.rabbet.com/oauth/token, scopes: read)

Path parameters

importIdstring uuid required

Import UUID, from the 202 that accepted it.

Query parameters

status'pending' | 'succeeded' | 'unchanged' | 'failed'

pending until applied; then succeeded (values written), unchanged (values already matched, nothing written), or failed (refused, see problem).

Only rows with this outcome.

limitinteger

Page size, between 1 and 100.

cursorstring

Opaque cursor from the previous page's pagination.next_cursor.

Response

A page of rows (empty when none match).

Example response

{
  "data": [
    {
      "index": 17,
      "problem": {
        "code": "VALIDATION_FAILED",
        "title": "Validation failed",
        "detail": "Set values only for custom fields this project's type defines; discover them via GET /project-types.",
        "errors": [
          {
            "field": "name",
            "code": "REQUIRED",
            "detail": "is required"
          }
        ]
      }
    }
  ],
  "pagination": {
    "next_cursor": "g3QAAAACdwJpZG0AAAAkZDI5MGYxZWU"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.