v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Protocols

Search for items

Search for items using specified criteria

post/v1/artifacts/protocols/search

Query parameters

valuestring required

The search string

limitinteger

The maximum number of results to return

include_prereleasesboolean

Include prerelease artifacts in search

Response

A list of items that match the search query

namespacestring required

slugstring required

versionstring required

namestring nullable

descriptionstring nullable

createdAtstring date-time required

lastUpdatedAtstring date-time required

otherVersionsstring[]

type'protocol' required

protocolSchema'v2' | 'v3' | 'tfv1' required

triggerTypeFileboolean required

triggerTypeScheduledboolean required

Example response

[
  {
    "type": "protocol",
    "namespace": "common",
    "slug": "akta",
    "version": "v1.2.18",
    "createdAt": "2023-02-16T15:15:34.269Z",
    "lastUpdatedAt": "2023-02-16T15:15:34.269Z",
    "name": "A demo protocol",
    "description": "The description for the demo protocol",
    "otherVersions": [
      "v1.2.18",
      "v1.2.17",
      "v1.1.0",
      "v0.0.10"
    ]
  }
]