Get GenerateTestJob - Synap API (Beta)

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (GenerateTestJob)

required

id

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

GenerateTestJob

Example:

GenerateTestJob

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "GenerateTestJob",
        "attributes": {
            "source": {
                "type": "collection",
                "objectId": "string"
            },
            "length": 0,
            "tagFilters": {
                "weightingType": "percentage",
                "filterRules": [
                    {
                        "weighting": 0,
                        "matchingRules": [
                            {}
                        ]
                    }
                ]
            },
            "masteryLevels": [
                "unseen"
            ],
            "state": "pending"
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "tagSet": {
                "data": {
                    "id": "FID001",
                    "type": "TagSet"
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error