Works

Export Works (POST)

Exports a collection of work items.

POST
/works.export
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

type?array<work-type>

Filters for work of the provided types.

actual_close_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
applies_to_part?array<string>

Filters for work belonging to any of the provided parts.

created_by?array<string>

Filters for work created by any of these users.

created_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
first?integer

The number of work items to return. The default is '50', the maximum is '5000'.

Formatint32
issue?works-filter-issue
modified_by?array<string>

Filters for work modified by any of these users.

modified_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
owned_by?array<string>

Filters for work owned by any of these users.

reported_by?array<string>

Filters for work reported by any of these users.

stage?stage-filter

The filter for stages.

staged_info?staged-info-filter
state?array<string>

Filters for work with any of the provided states.

sync_metadata?sync-metadata-filter
tags?array<string>

Filters for work with any of the provided tags.

target_close_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
ticket?works-filter-ticket

Response Body

curl -X POST "https://api.devrev.ai/works.export" \  -H "Content-Type: application/json" \  -d '{}'
{
  "works": [
    {
      "type": "issue",
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "applies_to_part": {
        "type": "capability",
        "display_id": "string",
        "id": "string",
        "name": "string",
        "owned_by": [
          {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          }
        ]
      },
      "artifacts": [
        {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        }
      ],
      "body": "string",
      "owned_by": [
        {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        }
      ],
      "reported_by": [
        {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        }
      ],
      "stage": {
        "name": "string"
      },
      "tags": [
        {
          "tag": {
            "display_id": "string",
            "id": "string",
            "name": "string"
          },
          "value": "string"
        }
      ],
      "target_close_date": "2023-01-01T12:00:00.000Z",
      "title": "string",
      "developed_with": [
        {
          "type": "capability",
          "display_id": "string",
          "id": "string",
          "name": "string",
          "owned_by": [
            {
              "type": "dev_user",
              "display_id": "string",
              "id": "string",
              "display_name": "string",
              "display_picture": {
                "display_id": "string",
                "id": "string",
                "file": {
                  "type": "string",
                  "name": "string",
                  "size": 0
                }
              },
              "email": "string",
              "full_name": "string",
              "state": "active"
            }
          ]
        }
      ],
      "estimated_effort": 0.1,
      "priority": "p0",
      "priority_v2": {
        "id": 0,
        "label": "string",
        "ordinal": 0,
        "value": null
      },
      "sla_summary": {
        "closest_to_breach_metric": "string",
        "org_schedule": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "status": "archived",
          "timezone": "string",
          "valid_until": "2023-01-01T12:00:00.000Z"
        },
        "remaining_time": 0,
        "sla_tracker": {
          "created_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "created_date": "2023-01-01T12:00:00.000Z",
          "display_id": "string",
          "id": "string",
          "modified_by": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "modified_date": "2023-01-01T12:00:00.000Z",
          "applies_to_id": "string",
          "applies_to_type": "conversation",
          "metric_target_summaries": [
            {
              "breached_at": "2023-01-01T12:00:00.000Z",
              "completed_at": "2023-01-01T12:00:00.000Z",
              "completed_in": 0,
              "in_policy": true,
              "is_out_of_schedule": true,
              "metric_definition": {
                "display_id": "string",
                "id": "string",
                "name": "string"
              },
              "next_schedule_transition": "2023-01-01T12:00:00.000Z",
              "org_schedule": {
                "display_id": "string",
                "id": "string",
                "name": "string",
                "status": "archived",
                "timezone": "string",
                "valid_until": "2023-01-01T12:00:00.000Z"
              },
              "remaining_time": 0,
              "stage": "string",
              "status": "string",
              "target_time": "2023-01-01T12:00:00.000Z",
              "warning_target_time": "2023-01-01T12:00:00.000Z"
            }
          ],
          "removed_sla_metric_history": [
            {}
          ],
          "sla": {
            "display_id": "string",
            "id": "string",
            "name": "string",
            "sla_type": "external",
            "status": "archived"
          },
          "sla_policy_id": "string",
          "stage": "string",
          "status": "string"
        },
        "stage": "breached",
        "target_time": "2023-01-01T12:00:00.000Z"
      },
      "sla_tracker": {
        "display_id": "string",
        "id": "string",
        "applies_to_type": "conversation"
      },
      "sprint": {
        "type": "curated",
        "end_date": "2023-01-01T12:00:00.000Z",
        "id": "string",
        "name": "string",
        "start_date": "2023-01-01T12:00:00.000Z",
        "state": "active"
      },
      "target_start_date": "2023-01-01T12:00:00.000Z"
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}