OSF

OSF Schema Response Actions API

Schema Response Actions are objects that when created cause state transitions for Schema Responses. Users use state transitions to submit, approve, and revise new Schema Responses. Schema Response Actions have a few different triggers to cause state transitions: - `submit` is a trigger to transition a Schema Response from an `in_progress` state to an `unapproved` state, this freezes edits for the Schema Response and allows all admin contributors to the Schema Response's Registration to either approved or reject the Schema Response. - `approve` is a trigger to transition a Schema Response from an `unapproved` state to an `approved` state, this makes the Schema Response changes public completing the update of the Schema Response. On Schema Responses that are associated with a Registration that has Registration Provider a moderated workflow the `approve` trigger will transition the Schema Response to `pending_moderation`. - `accept` is a trigger to transition a Schema Response from an `pending_moderation` state to an `approved` state. This trigger is only valid for Schema Responses that are associated with a Registration that has Registration Provider a moderated workflow and only possible for a user designated as moderator of a Registration Provider. - `admin_reject` is a trigger to transition a Schema Response from an `unapproved` state to an `in_progress` state. This trigger allows users to reject purposed changes to a Schema Response. - `moderator_reject` is a trigger to transition a Schema Response from an `pending_moderation` state to an `in_progress` state. This trigger is only valid for Schema Responses that are associated with a Registration that has Registration Provider a moderated workflow and only possible for a user designated as moderator of a Registration Provider.

GitHub OpenAPI

Operations 3

GET /schema_responses/{schema_response_id}/actions/ Retrieve a list of Schema Response Actions for a Schema Response #
POST /schema_responses/{schema_response_id}/actions/ Create a new Schema Response Action #
GET /schema_responses/{schema_response_id}/actions/{schema_response_action_id} A Schema Response Action from a Schema Response #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/osf/openapi/osf-schema-response-actions-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osf:osf-schema-response-actions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osf-schema-response-actions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OSF APIv2 Documentation Schema Response Actions API
  description: This is the official documentation for the OSF (Open Science Framework) API v2.
  version: '2.0'
  termsOfService: https://osf.io/terms_of_use/
  contact:
    name: OSF Support Team
    email: support@osf.io
    url: https://help.osf.io/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://cdn.cos.io/media/images/cos_center_logo_small.original.png
    backgroundColor: transparent
servers:
- url: https://api.test.osf.io/v2
tags:
- name: Schema Response Actions
  description: Schema Response Actions are objects that when created cause state transitions for Schema Responses.
paths:
  /schema_responses/{schema_response_id}/actions/:
    get:
      summary: Retrieve a list of Schema Response Actions for a Schema Response
      description: 'This retrieves a paginated list of all Schema Response Actions created for a Schema Response.

        #### Returns

        Returns a JSON object with a `data` key containing the representation of the requested Schema Response Actions, if the request is successful.

        #### Errors

        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.'
      parameters:
      - in: path
        name: schema_response_id
        required: true
        description: The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.
        schema:
          type: string
      tags:
      - Schema Response Actions
      operationId: schema_response_action_read
      x-response-schema: Schema Response Actions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: Schema Response Actions
                properties:
                  id:
                    type: string
                    readOnly: true
                    description: The unique identifier of the Schema Response Action.
                  type:
                    type: string
                    readOnly: true
                    description: The type identifier of the Schema Response Action (`schema-response-actions`).
                  attributes:
                    type: object
                    title: Attributes
                    readOnly: true
                    properties:
                      trigger:
                        enum:
                        - submit
                        - approve
                        - accept
                        - admin_reject
                        - moderator_reject
                        type: string
                        readOnly: false
                        description: The name of the trigger that caused the action.
                      from_state:
                        enum:
                        - initial
                        - in_progress
                        - approved
                        - pending_moderation
                        type: string
                        readOnly: false
                        description: The name of the state of the Schema Response prior to the creation of the action.
                      to_state:
                        enum:
                        - in_progress
                        - approved
                        - pending_moderation
                        type: string
                        readOnly: false
                        description: The name of the state of the Schema Response after the creation of the action
                      comment:
                        type: string
                        readOnly: true
                        description: A comment made explaining the reasoning of the action.
                      date_created:
                        type: string
                        readOnly: true
                        description: The date the action was created.
                      auto:
                        type: boolean
                        readOnly: true
                        description: Bool of representing whether a user created the action.
                      visible:
                        type: boolean
                        readOnly: true
                        description: Bool of representing whether the action is visible.
                  relationships:
                    type: object
                    title: Relationships
                    readOnly: true
                    description: Links to other entities or entity collections that have a relationship to the Schema Response Action entity.
                    properties:
                      creator:
                        type: string
                        format: URL
                        readOnly: true
                        description: A link to the node the file is on.
                      target:
                        type: string
                        format: URL
                        readOnly: true
                        description: A link to the node the file is on.
                  links:
                    type: object
                    title: Links
                    readOnly: true
                    description: URLs to alternative representations of the Registration Schema entity.
                    properties:
                      self:
                        type: string
                        format: URL
                        readOnly: true
                        description: A link to the detail page for a Registration Schema.
              example:
                data:
                - id: 61b9eae1a7d8ac025c4c46d3
                  type: schema-response-actions
                  attributes:
                    trigger: submit
                    comment: ''
                    from_state: in_progress
                    to_state: unapproved
                    date_created: '2021-12-15T13:17:21.845573Z'
                    date_modified: '2021-12-15T13:17:21.845622Z'
                    auto: false
                    visible: true
                  relationships:
                    creator:
                      links:
                        related:
                          href: https://api.osf.io/v2/users/zfsr2/
                          meta: {}
                      data:
                        id: zfsr2
                        type: users
                    target:
                      links:
                        related:
                          href: https://api.osf.io/v2/schema_responses/61b9cd62eb66180215222669/
                          meta: {}
                      data:
                        id: 61b9cd62eb66180215222669
                        type: schema_responses
                  embeds:
                    creator:
                      data:
                        id: zfsr2
                        type: users
                        attributes:
                          full_name: Lukasz Okruszek
                          given_name: Łukasz
                          middle_names: ''
                          family_name: Okruszek
                          suffix: ''
                          date_registered: '2017-02-02T21:32:45.495000Z'
                          active: true
                          timezone: Europe/Budapest
                          locale: pl
                          social:
                            ssrn: ''
                            orcid: 0000-0002-7136-2864
                            github: []
                            scholar: CHyWD84AAAAJ&hl
                            twitter: []
                            linkedIn: []
                            impactStory: ''
                            baiduScholar: ''
                            researchGate: Lukasz-Okruszek
                            researcherId: ''
                            profileWebsites: []
                            academiaProfileID: ''
                            academiaInstitution: ''
                          employment:
                          - title: Head
                            endYear: ''
                            ongoing: true
                            endMonth: 0
                            startYear: '2016'
                            department: Social Neuroscience Lab
                            startMonth: 9
                            institution: Institute of Psychology, Polish Academy of Sciences
                          education: []
                        relationships:
                          nodes:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/nodes/
                                meta: {}
                          groups:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/groups/
                                meta: {}
                          quickfiles:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/quickfiles/
                                meta: {}
                              upload:
                                href: https://files.osf.io/v1/resources/ytg45jbs3r/providers/osfstorage/
                                meta: {}
                              download:
                                href: https://files.osf.io/v1/resources/ytg45jbs3r/providers/osfstorage/?zip=
                                meta: {}
                          registrations:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/registrations/
                                meta: {}
                          institutions:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/institutions/
                                meta: {}
                              self:
                                href: https://api.osf.io/v2/users/zfsr2/relationships/institutions/
                                meta: {}
                          preprints:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/preprints/
                                meta: {}
                        links:
                          html: https://osf.io/zfsr2/
                          profile_image: https://secure.gravatar.com/avatar/8a25f4601ac997f113b3145aa5cf907e?d=identicon
                          self: https://api.osf.io/v2/users/zfsr2/
                  links:
                    self: https://api.osf.io/v2/actions/61b9eae1a7d8ac025c4c46d3/
                - id: 61b9eaf13cddaa026ef7245d
                  type: schema-response-actions
                  attributes:
                    trigger: approve
                    comment: ''
                    from_state: unapproved
                    to_state: approved
                    date_created: '2021-12-15T13:17:37.195568Z'
                    date_modified: '2021-12-15T13:17:37.195597Z'
                    auto: false
                    visible: true
                  relationships:
                    creator:
                      links:
                        related:
                          href: https://api.osf.io/v2/users/zfsr2/
                          meta: {}
                      data:
                        id: zfsr2
                        type: users
                    target:
                      links:
                        related:
                          href: https://api.osf.io/v2/schema_responses/61b9cd62eb66180215222669/
                          meta: {}
                      data:
                        id: 61b9cd62eb66180215222669
                        type: schema_responses
                  embeds:
                    creator:
                      data:
                        id: zfsr2
                        type: users
                        attributes:
                          full_name: Test User
                          given_name: Test
                          middle_names: ''
                          family_name: User
                          suffix: ''
                          date_registered: '2017-02-02T21:32:45.495000Z'
                          active: true
                          timezone: Europe/Budapest
                          locale: pl
                          social:
                            ssrn: ''
                            orcid: 0000-0002-7136-286X
                            github: []
                            scholar: ''
                            twitter: []
                            linkedIn: []
                            impactStory: ''
                            baiduScholar: ''
                            researchGate: test-user
                            researcherId: ''
                            profileWebsites: []
                            academiaProfileID: ''
                            academiaInstitution: ''
                          employment:
                          - title: Developer
                            endYear: ''
                            ongoing: true
                            endMonth: 0
                            startYear: '2017'
                            department: Denfense
                            startMonth: 9
                            institution: Institute of the Stars
                          education: []
                        relationships:
                          nodes:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/sfsr2/nodes/
                                meta: {}
                          groups:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/sfsr2/groups/
                                meta: {}
                          quickfiles:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/sfsr2/quickfiles/
                                meta: {}
                              upload:
                                href: https://files.osf.io/v1/resources/ytg45jbs3r/providers/osfstorage/
                                meta: {}
                              download:
                                href: https://files.osf.io/v1/resources/ytg45jbs3r/providers/osfstorage/?zip=
                                meta: {}
                          registrations:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/sfsr2/registrations/
                                meta: {}
                          institutions:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/sfsr2/institutions/
                                meta: {}
                              self:
                                href: https://api.osf.io/v2/users/sfsr2/relationships/institutions/
                                meta: {}
                          preprints:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/sfsr2/preprints/
                                meta: {}
                        links:
                          html: https://osf.io/zfsr2/
                          profile_image: https://secure.gravatar.com/avatar/8a25f4601ac997f113b3145aa5cf907e?d=identicon
                          self: https://api.osf.io/v2/users/sfsr2/
                  links:
                    self: https://api.osf.io/v2/actions/61b9eaf13cddaa026ef7245d/
                meta:
                  total: 2
                  per_page: 10
                  version: '2.20'
                links:
                  self: https://api.osf.io/v2/schema_responses/61b9cd62eb66180215222669/actions/
                  first: null
                  last: null
                  prev: null
                  next: null
    post:
      summary: Create a new Schema Response Action
      description: 'This creates a new Schema Response Action in order to trigger a state transition for a Schema Response.

        #### Returns

        Returns a JSON object with a `data` key containing the representation of the requested Schema Response Actions, if the request is successful.

        #### Errors

        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.'
      parameters:
      - in: path
        name: schema_response_id
        required: true
        description: The unique identifier of the Registration Schema example `6176c9d45e01f100091d4f94`.
        schema:
          type: string
      tags:
      - Schema Response Actions
      operationId: postSchemaResponsesBySchemaResponseIdActions
      x-response-schema: Schema Response Actions
      responses:
        '201':
          description: OK
      x-operation-id-source: normalized
      x-operation-id-original: schema_response_action_read
  /schema_responses/{schema_response_id}/actions/{schema_response_action_id}:
    get:
      summary: A Schema Response Action from a Schema Response
      description: 'Retrieves a Schema Response Action by it''s ID.

        #### Returns

        Returns a JSON object with a `data` key containing the representation of the requested Schema Response Actions, if the request is successful.

        #### Errors

        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.'
      parameters:
      - in: path
        name: schema_response_id
        required: true
        description: The unique identifier of the Schema Response example `61b9cd62eb66180215222669`.
        schema:
          type: string
      - in: path
        name: schema_response_action_id
        required: true
        description: The unique identifier of the Schema Response Action example `61b9eae1a7d8ac025c4c46d3`.
        schema:
          type: string
      tags:
      - Schema Response Actions
      operationId: getSchemaResponsesBySchemaResponseIdActionsBySchemaResponseActionId
      x-response-schema: Schema Response Actions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: Schema Response Actions
                properties:
                  id:
                    type: string
                    readOnly: true
                    description: The unique identifier of the Schema Response Action.
                  type:
                    type: string
                    readOnly: true
                    description: The type identifier of the Schema Response Action (`schema-response-actions`).
                  attributes:
                    type: object
                    title: Attributes
                    readOnly: true
                    properties:
                      trigger:
                        enum:
                        - submit
                        - approve
                        - accept
                        - admin_reject
                        - moderator_reject
                        type: string
                        readOnly: false
                        description: The name of the trigger that caused the action.
                      from_state:
                        enum:
                        - initial
                        - in_progress
                        - approved
                        - pending_moderation
                        type: string
                        readOnly: false
                        description: The name of the state of the Schema Response prior to the creation of the action.
                      to_state:
                        enum:
                        - in_progress
                        - approved
                        - pending_moderation
                        type: string
                        readOnly: false
                        description: The name of the state of the Schema Response after the creation of the action
                      comment:
                        type: string
                        readOnly: true
                        description: A comment made explaining the reasoning of the action.
                      date_created:
                        type: string
                        readOnly: true
                        description: The date the action was created.
                      auto:
                        type: boolean
                        readOnly: true
                        description: Bool of representing whether a user created the action.
                      visible:
                        type: boolean
                        readOnly: true
                        description: Bool of representing whether the action is visible.
                  relationships:
                    type: object
                    title: Relationships
                    readOnly: true
                    description: Links to other entities or entity collections that have a relationship to the Schema Response Action entity.
                    properties:
                      creator:
                        type: string
                        format: URL
                        readOnly: true
                        description: A link to the node the file is on.
                      target:
                        type: string
                        format: URL
                        readOnly: true
                        description: A link to the node the file is on.
                  links:
                    type: object
                    title: Links
                    readOnly: true
                    description: URLs to alternative representations of the Registration Schema entity.
                    properties:
                      self:
                        type: string
                        format: URL
                        readOnly: true
                        description: A link to the detail page for a Registration Schema.
              example:
                data:
                  id: 61b9eae1a7d8ac025c4c46d3
                  type: schema-response-actions
                  attributes:
                    trigger: submit
                    comment: ''
                    from_state: in_progress
                    to_state: unapproved
                    date_created: '2021-12-15T13:17:21.845573Z'
                    date_modified: '2021-12-15T13:17:21.845622Z'
                    auto: false
                    visible: true
                  relationships:
                    creator:
                      links:
                        related:
                          href: https://api.osf.io/v2/users/zfsr2/
                          meta: {}
                      data:
                        id: zfsr2
                        type: users
                    target:
                      links:
                        related:
                          href: https://api.osf.io/v2/schema_responses/61b9cd62eb66180215222669/
                          meta: {}
                      data:
                        id: 61b9cd62eb66180215222669
                        type: schema_responses
                  embeds:
                    creator:
                      data:
                        id: zfsr2
                        type: users
                        attributes:
                          full_name: Lukasz Okruszek
                          given_name: Łukasz
                          middle_names: ''
                          family_name: Okruszek
                          suffix: ''
                          date_registered: '2017-02-02T21:32:45.495000Z'
                          active: true
                          timezone: Europe/Budapest
                          locale: pl
                          social:
                            ssrn: ''
                            orcid: 0000-0002-7136-2864
                            github: []
                            scholar: CHyWD84AAAAJ&hl
                            twitter: []
                            linkedIn: []
                            impactStory: ''
                            baiduScholar: ''
                            researchGate: Lukasz-Okruszek
                            researcherId: ''
                            profileWebsites: []
                            academiaProfileID: ''
                            academiaInstitution: ''
                          employment:
                          - title: Head
                            endYear: ''
                            ongoing: true
                            endMonth: 0
                            startYear: '2016'
                            department: Social Neuroscience Lab
                            startMonth: 9
                            institution: Institute of Psychology, Polish Academy of Sciences
                          education: []
                        relationships:
                          nodes:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/nodes/
                                meta: {}
                          groups:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/groups/
                                meta: {}
                          quickfiles:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/quickfiles/
                                meta: {}
                              upload:
                                href: https://files.osf.io/v1/resources/ytg45jbs3r/providers/osfstorage/
                                meta: {}
                              download:
                                href: https://files.osf.io/v1/resources/ytg45jbs3r/providers/osfstorage/?zip=
                                meta: {}
                          registrations:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/registrations/
                                meta: {}
                          institutions:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/institutions/
                                meta: {}
                              self:
                                href: https://api.osf.io/v2/users/zfsr2/relationships/institutions/
                                meta: {}
                          preprints:
                            links:
                              related:
                                href: https://api.osf.io/v2/users/zfsr2/preprints/
                                meta: {}
                        links:
                          html: https://osf.io/zfsr2/
                          profile_image: https://secure.gravatar.com/avatar/8a25f4601ac997f113b3145aa5cf907e?d=identicon
                          self: https://api.osf.io/v2/users/zfsr2/
                    links:
                      self: https://api.osf.io/v2/actions/61b9eae1a7d8ac025c4c46d3/
                meta:
                  total: 2
                  per_page: 10
                  version: '2.20'
                links:
                  self: https://api.osf.io/v2/schema_responses/61b9cd62eb66180215222669/actions/
                  first: null
                  last: null
                  prev: null
                  next: null
      x-operation-id-source: normalized
      x-operation-id-original: schema_response_action_read
x-tagGroups:
- name: Welcome
  tags:
  - Introduction
  - General Usage
  - Authentication
  - Pagination
  - Versioning
  - Filtering
  - Sparse Fieldsets
  - Embedding
  - Request Formatting
  - Errors & Error Codes
  - Entities & Entity Collections
- name: API Reference
  tags:
  - Actions
  - Addons
  - Applications
  - Base
  - CEDAR Metadata
  - Citations
  - Comments
  - Collections
  - Collection Submissions
  - Collection Submissions Actions
  - Collection Providers
  - Custom Metadata
  - Files
  - Licenses
  - Logs
  - Institutions
  - Identifiers
  - Registration Schemas
  - Registration Schema Blocks
  - Schema Responses
  - Schema Response Actions
  - Nodes
  - Notification Subscriptions
  - Preprints
  - Preprint Providers
  - Draft Registrations
  - Registrations
  - Registration Providers
  - Regions
  - OAuth Scopes
  - Taxonomies
  - Tokens
  - Users
  - View Only Links
  - Wikis
  - Subjects
  - GUIDs
  - Requests
  - Resources