XNAT API Documentation
XNAT API Documentation
Breadcrumbs

Experiment Sharing API

Share An Experiment Into A New Project

Sharing an experiment by itself has no effect if the subject that owns the experiment is not also shared.

PUT - /data/projects/{original-project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/projects/{shared-project-id}

Parameters

{original-project-id}

Required path parameter. Specify the ID of the project that owns a given subject.

{subject-id} or {subject-label}

Required path parameter.

{experiment-id} or {experiment-label}

Required path parameter.

{shared-project-id}

Required path parameter. Specify the ID of the project that you intend a subject to be shared into.

Logged-in user must have ownership permissions in the shared project.

label

Optional querystring parameter. Specify a new label for this experiment that will be used in the shared project, if desired.

primary

Optional querystring parameter.

  • If set to "true", you are changing the primary ownership of the experiment from the original project to the new project.

Logged-in user must have ownership permissions in both projects to change the primary ownership.

Response Codes

200

OK

403

Forbidden (User does not have permission to perform the requested operation)

404

Project Not Found

409

Conflict Found – Attempting to share data into an object that already exists

Response Format

Returns the experiment accession ID as a string

Get A List Of Shared Projects Associated With An Experiment 

GET - /data/projects/{original-project-id}/subjects/{subject-id | subject-label}/experiments/{experiment-id | experiment-label}/projects

Parameters

{original-project-id}

Required path parameter. Specify the ID of the project that owns a given subject.

{subject-id} or {subject-label}

Required path parameter.

{experiment-id} or {experiment-label}

Required path parameter.

format

Optional querystring parameter. Specify the format of the returned response.

  • html (default)

  • json

  • xml

  • csv

Response

Displaying JSON results. Note that the response does not specify which project owns an experiment.

{
  "ResultSet": {
    "Result": [
      {
        "label": "string",
        "ID": "string",
        "Secondary_ID": "string",
        "Name": "string"
      },
      ...
    ]
  }
}