Skip to main content

Find 'TestCase' entities using the specified (query) parameters

GET 
/testcase

Same as POST /find, but serializing the query in the 'q' parameter instead of the request body

Request​

Query Parameters

    q string

    The DataReadParams query as JSON or base64-encoded JSON - See POST route

    Example: {"filter": {"id": 1}}

Responses​

Returns FindResult of type 'TestCase' expanded with specified mapped values

Schema

    data

    object[]

    required

  • Array [

    • id integer

    The unique entity id - must be a positive integer

    title string

    A descriptive title for this entity or mapping (1 to 200 characters)

    Example: A Descriptive Title
    sort_index number

    An integer sort index for natural ordering of this entity or mapping value - value must be in range (-999999999999999,999999999999999)

    is_deleted boolean

    If the entity has been soft-deleted this value is true

    created_at date-time

    The creation time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    created_by number

    The creator user id of this entity or mapping value - or zero if created by the system

    Example: 0
    modified_at date-time

    The last modification time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    modified_by number

    The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

    Example: 0
    deleted_at date-time

    The soft-deletion time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    deleted_by number

    The id of the user who deleted this entity or mapping value - or zero if deleted by the system

    Example: 0
    _etag stringrequired

    A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)

    project_id integer

    The project id this entity or mapping belongs to

    owner_user_id integer

    The global user id of the test case owner

    $owner_name string

    The resolved display name of the owner user - read only

    type string

    Reserved for future use

    template string

    The template type used for the test case: STEPS or TEXT

    precondition_text string

    A description of the precondition required for the test case (can be a rich text document)

    Example:
    content_text string

    The test case content - used with template STEPS (can be a rich text document)

    Example:
    steps_text string

    The test case content - used with template TEXT (can be a rich text document)

    Example:
    expected_result_text string

    The test case expected result - used with template TEXT (can be a rich text document)

    Example:
    priority number

    The test case priority (This is a builtin-custom field)

    Example: 1
    status string

    The test case status (This is a builtin-custom field)

    Example:
    testcase_type string

    The test case type (This is a builtin-custom field)

    Example:
    automation string

    The test case automation status (This is a builtin-custom field)

    Example:
    estimate number

    A test case time estimate (This is a builtin-custom field)

    Example: 100

  • ]

    • meta

    object

    required

    count integerrequired
    limit integer
    offset integerrequired
    totalCount integer
Loading...