List SPB sends
curl --request GET \
--url https://api.example.com/v1/send-journal \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/send-journal"
req, _ := http.NewRequest("GET", 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: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/send-journal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/v1/send-journal"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"channelId": "spb",
"closedByHand": {
"closedAt": "2023-11-07T05:31:56Z",
"closedBy": "<string>",
"evidenceReference": "<string>",
"note": "<string>"
},
"controlId": "<string>",
"engineId": "<string>",
"outcome": "DETERMINED",
"queries": {
"count": 2,
"lastAnswer": "VENDOR",
"lastQueriedAt": "2023-11-07T05:31:56Z"
},
"resolution": {
"actualOutcome": "REACHED_VENDOR",
"means": "<string>",
"note": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z",
"resolvedBy": "<string>"
},
"sentAt": "2023-11-07T05:31:56Z",
"vendorCode": "<string>",
"vendorSequence": "<string>",
"ageSeconds": 123
}
],
"limit": 2,
"page": 2
}{
"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"
}
}{
"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"
}
}{
"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"
}
}{
"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"
}
}{
"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"
}
}List SPB sends
Answers “is there a send in unknown state?”. Every send enters the journal before it leaves, so a send whose answer never came back is here as INDETERMINATE rather than missing. Newest first. SPB rail only.
GET
/
v1
/
send-journal
List SPB sends
curl --request GET \
--url https://api.example.com/v1/send-journal \
--header 'Authorization: Bearer <token>'package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/send-journal"
req, _ := http.NewRequest("GET", 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: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/send-journal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.example.com/v1/send-journal"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"channelId": "spb",
"closedByHand": {
"closedAt": "2023-11-07T05:31:56Z",
"closedBy": "<string>",
"evidenceReference": "<string>",
"note": "<string>"
},
"controlId": "<string>",
"engineId": "<string>",
"outcome": "DETERMINED",
"queries": {
"count": 2,
"lastAnswer": "VENDOR",
"lastQueriedAt": "2023-11-07T05:31:56Z"
},
"resolution": {
"actualOutcome": "REACHED_VENDOR",
"means": "<string>",
"note": "<string>",
"resolvedAt": "2023-11-07T05:31:56Z",
"resolvedBy": "<string>"
},
"sentAt": "2023-11-07T05:31:56Z",
"vendorCode": "<string>",
"vendorSequence": "<string>",
"ageSeconds": 123
}
],
"limit": 2,
"page": 2
}{
"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"
}
}{
"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"
}
}{
"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"
}
}{
"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"
}
}{
"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"
}
}Autorizações
JWT bearer token issued by the identity provider.
Parâmetros de consulta
Page, 1-based.
Intervalo obrigatório:
x >= 1Items per page.
Intervalo obrigatório:
1 <= x <= 200true keeps exactly what SPBIndeterminateSendStale counts: INDETERMINATE sends nobody closed by hand. false or omitted does not filter.
Filter by outcome. Omitted returns every outcome.
Opções disponíveis:
DETERMINED, INDETERMINATE, RESOLVED, NOT_SENT Filter by originating engine.
Maximum string length:
32Filter by control identifier (exact).
Maximum string length:
256Sends at or after this instant.
Sends before this instant.
Esta página foi útil?

