v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Registrations

Create a fork

Creates a fork of the given registration.

Forking a project creates a copy of an existing registration and all of its contents. The fork always points back to the original registration, forming a network of registrations.

You might use a fork to copy another's work to build on and extend. For example, a professor may create an OSF project of materials for individual student use. Each student forks the project to have his or her own copy of the materials to start his/her own work.

When creating a fork, your fork will only contain public components of the current registration and components for which you are a contributor. Private components that you do not have access to will not be forked.

Required

There are no required attributes when creating a fork, as all of the forked registration's attributes will be copied from the current registration.

The title field is optional, with the default title being "Fork of " prepended to the current registration's title.

Returns

Returns a JSON object with a data key containing the complete representation of the forked registration, if the request is successful. If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

post/registrations/{registration_id}/forks/

Path parameters

registration_idstring required

The unique identifier of the registration.

Request body

idstring required

The unique identifier of the registration.

typestring required

The type identifier of the registration entity (registrations).

Example request

{
  "data": {
    "type": "registrations",
    "attributes": {
      "draft_registration": "{draft_registration_id}",
      "registration_choice": "embargo",
      "lift_embargo": "2017-05-10T20:44:03.185000"
    }
  }
}

Response

Created