github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/jobs/index_account.yaml (about)

     1  ---
     2  summary: List account jobs
     3  description: List all jobs for the given account.
     4  operationId: jobs/by_account
     5  tags:
     6  - Jobs
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/account_id"
    10  - "$ref": "../../parameters.yaml#/page"
    11  - "$ref": "../../parameters.yaml#/per_page"
    12  - description: filter by user owning job
    13    example: abcd1234cdef1234abcd1234cdef1234
    14    name: owned_by
    15    in: query
    16    schema:
    17      type: string
    18  - description: filter by user assigned to job
    19    example: abcd1234cdef1234abcd1234cdef1234
    20    name: assigned_to
    21    in: query
    22    schema:
    23      type: string
    24  - description: filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>
    25    example: completed
    26    name: state
    27    in: query
    28    schema:
    29      type: string
    30  responses:
    31    '200':
    32      description: OK
    33      content:
    34        application/json:
    35          schema:
    36            type: array
    37            items:
    38              "$ref": "../../schemas/job.yaml#/job"
    39      headers:
    40        X-Rate-Limit-Limit:
    41          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    42        X-Rate-Limit-Remaining:
    43          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    44        X-Rate-Limit-Reset:
    45          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    46        Link:
    47          "$ref": "../../headers.yaml#/Link"
    48        Pagination:
    49          "$ref": "../../headers.yaml#/Pagination"
    50    '400':
    51      "$ref": "../../responses.yaml#/400"
    52    '404':
    53      "$ref": "../../responses.yaml#/404"
    54    '429':
    55      "$ref": "../../responses.yaml#/429"
    56  x-code-samples:
    57  - lang: Curl
    58    source: |-
    59      curl "https://api.phrase.com/v2/accounts/:account_id/jobs?owned_by=abcd1234cdef1234abcd1234cdef1234&assigned_to=abcd1234cdef1234abcd1234cdef1234&state=completed" \
    60        -u USERNAME_OR_ACCESS_TOKEN
    61  - lang: CLI v2
    62    source: |-
    63      phrase jobs by_account \
    64      --account_id <account_id> \
    65      --owned_by abcd1234cdef1234abcd1234cdef1234 \
    66      --assigned_to abcd1234cdef1234abcd1234cdef1234 \
    67      --state completed \
    68      --access_token <token>
    69  x-cli-version: '2.5'