Sanityioconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 4 actions for the Sanityioconnector v1.0.

General (4)

POST Mutation

/{apiVersion}/data/mutate/{dataset}

Mutation

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Apiversion`	The version of the Sanity API to use, typically a date string like '2021-06-07'.
`Dataset`	The name of the Sanity dataset to mutate.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Query

/{apiVersion}/data/query/{dataset}

Query

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Apiversion`	The version of the Sanity API to use, typically a date string.
`Dataset`	The name of the Sanity dataset to query.
`Query`	The GROQ query string to execute.
`Perspective`	The query perspective, such as 'raw' or 'published', which controls which document versions are included.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload a File Asset

/{apiVersion}}/assets/files/{dataset}

Upload a File Asset

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Apiversion`	The version of the Sanity API to use.
`Dataset`	The name of the Sanity dataset to upload the file to.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Upload an Image Asset

/{apiVersion}}/assets/images/{dataset}

Upload an Image Asset

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Apiversion`	The version of the Sanity API to use.
`Dataset`	The name of the Sanity dataset to upload the image to.
`Response Type`	The response format expected from the API (e.g. application/json).