Create GeneratedTest - Synap API (Beta)

Request

Query Params

include

array[string]

optional

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

GeneratedTest

Example:

GeneratedTest

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "type": "GeneratedTest",
        "attributes": {
            "source": {
                "type": "collection",
                "objectId": "string"
            },
            "length": 0,
            "tagFilters": {},
            "tagSetId": "string"
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "tagSet": {
                "data": {
                    "id": "FID001",
                    "type": "TagSet"
                }
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (GeneratedTest)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

GeneratedTest

Example:

GeneratedTest

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "GeneratedTest",
        "attributes": {
            "source": {
                "type": "collection",
                "objectId": "string"
            },
            "length": 0,
            "tagFilters": {},
            "tagSetId": "string"
        },
        "relationships": {
            "test": {
                "data": {
                    "id": "FID001",
                    "type": "Test"
                }
            },
            "tagSet": {
                "data": {
                    "id": "FID001",
                    "type": "TagSet"
                }
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409