# OSF Schema Response Actions API

**Canonical:** https://apis.io/apis/osf/osf-schema-response-actions-api/  
**Provider:** OSF — https://apis.io/providers/osf/  
**Base URL:** https://api.osf.io  
**Documentation:** https://developer.osf.io

OSF Schema Response Actions API is one of 41 APIs that [OSF](https://apis.io/providers/osf/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Schema Response Actions. The published artifact set on APIs.io includes an OpenAPI specification.

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.

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (1)

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

## Other OSF APIs (12)

- [OSF API](https://apis.io/apis/osf/osf-api/)
- [OSF Actions API](https://apis.io/apis/osf/osf-actions-api/)
- [OSF Applications API](https://apis.io/apis/osf/osf-applications-api/)
- [OSF Base API](https://apis.io/apis/osf/osf-base-api/)
- [OSF CEDAR Metadata API](https://apis.io/apis/osf/osf-cedar-metadata-api/)
- [OSF Citations API](https://apis.io/apis/osf/osf-citations-api/)
- [OSF Collection Providers API](https://apis.io/apis/osf/osf-collection-providers-api/)
- [OSF Collection Submission Actions API](https://apis.io/apis/osf/osf-collection-submission-actions-api/)
- [OSF Collection Submissions API](https://apis.io/apis/osf/osf-collection-submissions-api/)
- [OSF Collections API](https://apis.io/apis/osf/osf-collections-api/)
- [OSF Comments API](https://apis.io/apis/osf/osf-comments-api/)
- [OSF Contributors API](https://apis.io/apis/osf/osf-contributors-api/)

## Tags

Schema Response Actions

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/osf/osf-schema-response-actions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/osf/.