Create a shift-handoff draft

curl --request POST \
  --url https://api.example.com/v1/handoffs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evidence": [
    {
      "label": "STR operation abc",
      "path": "/str/operations/abc"
    }
  ],
  "note": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/handoffs"

	payload := strings.NewReader("{\n  \"evidence\": [\n    {\n      \"label\": \"STR operation abc\",\n      \"path\": \"/str/operations/abc\"\n    }\n  ],\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    evidence: [{label: 'STR operation abc', path: '/str/operations/abc'}],
    note: '<string>'
  })
};

fetch('https://api.example.com/v1/handoffs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/handoffs"

payload = {
    "evidence": [
        {
            "label": "STR operation abc",
            "path": "/str/operations/abc"
        }
    ],
    "note": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2023-11-07T05:31:56Z",
  "evidence": [
    {
      "label": "STR operation abc",
      "path": "/str/operations/abc"
    }
  ],
  "id": "<string>",
  "note": "<string>",
  "owner": {
    "sub": "<string>",
    "owner": "<string>"
  },
  "status": "draft",
  "updatedAt": "2023-11-07T05:31:56Z",
  "approvedBy": {
    "sub": "<string>",
    "owner": "<string>"
  },
  "receiptId": "<string>",
  "submittedBy": {
    "sub": "<string>",
    "owner": "<string>"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

POST

handoffs

Create a shift-handoff draft

curl --request POST \
  --url https://api.example.com/v1/handoffs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "evidence": [
    {
      "label": "STR operation abc",
      "path": "/str/operations/abc"
    }
  ],
  "note": "<string>"
}
'

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/handoffs"

	payload := strings.NewReader("{\n  \"evidence\": [\n    {\n      \"label\": \"STR operation abc\",\n      \"path\": \"/str/operations/abc\"\n    }\n  ],\n  \"note\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    evidence: [{label: 'STR operation abc', path: '/str/operations/abc'}],
    note: '<string>'
  })
};

fetch('https://api.example.com/v1/handoffs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/v1/handoffs"

payload = {
    "evidence": [
        {
            "label": "STR operation abc",
            "path": "/str/operations/abc"
        }
    ],
    "note": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "createdAt": "2023-11-07T05:31:56Z",
  "evidence": [
    {
      "label": "STR operation abc",
      "path": "/str/operations/abc"
    }
  ],
  "id": "<string>",
  "note": "<string>",
  "owner": {
    "sub": "<string>",
    "owner": "<string>"
  },
  "status": "draft",
  "updatedAt": "2023-11-07T05:31:56Z",
  "approvedBy": {
    "sub": "<string>",
    "owner": "<string>"
  },
  "receiptId": "<string>",
  "submittedBy": {
    "sub": "<string>",
    "owner": "<string>"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

{
  "correlationId": "req-7a3f9c2e",
  "code": "<string>",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Encabezados

Authorization

string

Cuerpo

application/json

Create an auditable shift-handoff draft.

evidence

object[] | null

requerido

One or more immutable canonical evidence references.

Show child attributes

note

string

requerido

Operator-authored context (1..1200 characters).

Respuesta

Created

createdAt

string<date-time>

requerido

evidence

object[]

requerido

Show child attributes

string

requerido

Stable handoff identifier.

note

string

requerido

owner

object

requerido

Show child attributes

status

enum<string>

requerido

Opciones disponibles:

draft,

submitted,

approved

updatedAt

string<date-time>

requerido

approvedBy

object

Show child attributes

receiptId

string

submittedBy

object

Show child attributes

Reconocimientos de alertas

Traspasos de turno

Aprobaciones de revisión manual

Eliminaciones de usuarios

Manejo de errores

Create a shift-handoff draft

Autorizaciones

Encabezados

Cuerpo

Respuesta