Submit a handoff for review

curl --request POST \
  --url https://api.example.com/v1/handoffs/{handoffId}/submit \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/v1/handoffs/{handoffId}/submit"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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>'}};

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

{
  "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

{handoffId}

submit

Submit a handoff for review

curl --request POST \
  --url https://api.example.com/v1/handoffs/{handoffId}/submit \
  --header 'Authorization: Bearer <token>'

package main

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

func main() {

	url := "https://api.example.com/v1/handoffs/{handoffId}/submit"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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>'}};

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

{
  "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

Parámetros de ruta

handoffId

string

requerido

Respuesta

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

Submit a handoff for review

Autorizaciones

Encabezados

Parámetros de ruta

Respuesta