Create Survey - Synap API (Beta)

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

Survey

Example:

Survey

attributes

object

required

relationships

object

optional

Example

{
    "data": {
        "type": "Survey",
        "attributes": {
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "isLibraryItem": true
        },
        "relationships": {}
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.synap.ac/v3/surveys' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "Survey",
        "attributes": {
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "isLibraryItem": true
        },
        "relationships": {}
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (Survey)

optional

id

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Survey

Example:

Survey

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Survey",
        "attributes": {
            "createdAt": "string",
            "updatedAt": "string",
            "title": "string",
            "description": "string",
            "shortDescription": "string",
            "selfAssessment": {},
            "totalItems": 0,
            "isLibraryItem": true,
            "isArchived": true
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "pages": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "SurveyPage"
                    }
                ]
            }
        }
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409