Add StudyItems

POST

/studies/{object_id}/relationships/items

Revision

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

array [object {2}]

optional

type

enum<string>

optional

Identifies the Resource.

Allowed value:

StudyItem

Example:

_User

attributes

object

optional

Example

{
    "data": [
        {
            "type": "StudyItem",
            "attributes": {
                "targetId": "FID001",
                "type": "collection"
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/studies//relationships/items' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": [
        {
            "type": "StudyItem",
            "attributes": {
                "targetId": "FID001",
                "type": "collection"
            }
        }
    ]
}'

Responses

🟢204No Content

application/vnd.api+json

Success

Body

No schema defined

Example

null

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-08 10:51:22

Create Study

Remove StudyItems