Skip to main content
MUTATION
editProtocolOverview(input: EditProtocolOverviewInput!, protocolId: String!, version: Int!): Protocol!

Arguments

The replacement description and tips.

protocolId
String!
required

Id of the protocol to edit.

version
Int!
required

Draft version of the protocol to edit.

Returns

author

The user credited as the protocol's author.

description
String

Overview of the protocol.

disposalNotes
String

Safety notes on waste disposal.

files

Files attached to the protocol. Empty if there are no files.

hazardsNotes
String

Safety notes on hazards.

id
String!

Id of the protocol, shared by all of its versions.

image
String

Identifier of the protocol's cover image file.

materials

Materials used in the protocol. Empty if there are no materials.

name
String!

Name of the protocol.

orgId
String!

Id of the organization the protocol belongs to.

procedure
JSON

Ids of the steps in the order they are performed. Empty if there are no steps.

protectionNotes
String

Safety notes on protective measures.

siteNames
[String!]!

Names of the sites the protocol is limited to. Empty if there are no site restrictions.

status
String!

One of 'DRAFT' (Draft) or 'PUBLISHED' (Published).

steps

Steps of the procedure; their order is given by procedure. Empty if there are no steps.

tags
[String!]!

Tags applied to the protocol. Empty if there are no tags.

tips
[String!]!

Tips for carrying out the protocol. Empty if there are no tips.

unresolvedCommentCount
Int!

Number of unresolved review comment threads on this version.

updatedAt
DateTime!

When this version was last modified.

version
Int!

Version number of the protocol, starting at 1.

versionLabel
String!

Display label of the version, for example 'v2'.

Mutation
Variables
Response