Worker API V3

Workload

Vanaf versie 1.9.2.0 is de Next functie uitgebreid met een detail optie. Dezelfde informatie als van een Reserve workload wordt getoond. Op deze manier kunnen requests die gereserveerd zijn, maar nog niet verder opgepakt zijn, toch verwerkt worden door een Robot.

Voorwaarde:

• Alleen workloads die een reserved (WRR) status hebben worden getoond

Endpoint	Type	Call
Workload	GET	/v3/work/next/detail/{WorkstationId}

Voorbeeld gereserveerde workload: WRR

{
  "ProcessId": 1,
  "ProcessSubject": "Project_Weather",
  "ProcessStepId": 1,
  "ProcessStepSubject": "GetTemperature_Today",
  "Workloads": [
    {
      "WorkloadId": 179,
      "RequestId": 93
    }
  ]
}

In het Spider dasboard staat dit request nu als gereserveerd gekenmerkt en is terug te vinden in de Todo. Echter wordt deze niet meer opnieuw gereserveerd. Om de robot dit request alsnog te laten verwerken kun je dus nu dezelfde informatie ophalen, zodat deze alsnog verwerkt kan worden.

Voorbeeld van een gereserveerd request uitlezen met next/detail:

{
  "ProcessId": 1,
  "ProcessSubject": "Project_Weather",
  "ProcessStepId": 1,
  "ProcessStepSubject": "GetTemperature_Today",
  "Workloads": [
    {
      "WorkloadId": 179,
      "RequestId": 93
    }
  ]
}

MileStoneLog

Operation	Type	Call
MileStoneLog	POST	/v3/milestonelog

Process status

Vanaf versie 1.6.11

Check of een proces op inMaintenance staat. Of zet de status weer op Active van een proces.

Operation	Type	Call
Process	GET	/v3/process/{processId}/inmaintenance
Process	PUT	/v3/process/{processId}/inmaintenance
Process	GET	/v1/process/export/{processId}/{fromDate}/{toDate}

Workload Status - SuccessAndFinish

Vanaf versie 1.7.0

Een request gelijk op success kunnen zetten, zonder de onderliggende processSteps uit te hoeven voeren. Alle onderliggende processSteps krijgen dan de status SuccessAndFinish

Operation	Type	Call
Workload	PUT	/v3/work/{workloadId}/{statusName}

Request Informatie

Versie 1.9.1.1

Het op kunnen vragen van informatie binnen een request zoals bijvoorbeeld de status, ParentId, StartDt, InsertDt en meer.

Operation	Type	Call
Request	GET	/v3/request/{id}

Input: RequestId

Response:

{
  "RequestId": 22,
  "ProcessId": 1,
  "Subject": "Project_Weather",
  "Type": "REQUEST",
  "ParentId": 0,
  "From": "SAIO",
  "Source": "SAIO",
  "Status": "RSS",
  "NumberOfTimesRestarted": 0,
  "StartDt": "2024-04-10T16:04:29",
  "InsertDt": "2024-04-10T16:04:28.413",
  "ActualStartDt": null,
  "FinishedDt": null
}

Zoek uitbreiding v2

Als aanvulling op 1.9.1.1 zijn er vanaf versie 1.12.0 meer onderdelen toegevoegd. Je kan nu o.a. zoeken op een Status, Datumrange, AllowNulls of een combinatie hiervan.

Operation	Type	Call
Request	GET	/v3/request/search

Optionele parameters kunnen gebruikt worden.

Optionele parameters

Parameter	Type	Omschrijving
pageNumber	Query	Welke pagina's wil je tonen.
pageSize	Query	Hoeveel resultaten moeten er per pagina getoond worden.
orderBy	Query	Kunnen orderen op onderdelen in de resultset (bijv: StartDt).
isAscending	Query	Sorteren op basis van selectie bij orderBy.

OrderBy

Parameter	Optie
pageNumber	Integer
pageSize	Integer
orderBy	RequestId
orderBy	ProcessId
orderBy	Subject
orderBy	Type
orderBy	ParentId
orderBy	From
orderBy	Source
orderBy	Status
orderBy	NumberOfTimesRestarted
orderBy	StartDt
orderBy	InsertDt
orderBy	ActualStartDt
orderBy	FinishedDt
isAscending	Empty (default false)
isAscending	True
isAscending	False

Voorwaarde zoeken

Processen

Minimaal één processId Of één Proces Subject.

Hierna kan er door middel van een enkele zoekterm gezocht worden, of een combinatie hiervan. In het geval van een combinatie dien je rekening te houden met onderstaande.

Datefield

Bij het gebruik van DateTimes en Source kan je alleen zoeken op bepaalde datumvelden. Zie hieronder welke velden beschikbaar zijn om te zoeken binnen het type 'Source'.

Datefield	StartDt	InsertDt	ActualStartDt	FinishedDt
Source: Staging		v
Source: Request	v	v	v	v

AllowNull

De AllowNull optie maakt het mogelijk om specifiek te zoeken. Ook hierbij de kanttekening dat niet elk veld een NULL status kan hebben.

Datefield	StartDt	InsertDt	ActualStartDt	FinishedDt
Source: Staging		NOT NULL
Source: Request	NULL	NOT NULL	NULL	NULL

Source

Deze toevoeging maakt het mogelijk om specifiek te zoeken in combinatie met de DateFields optie. Hieronder een overzicht wat je in combinatie kunt gebruiken voor de DateField optie gecombineerd met de Source

DateTimes	Optie	StartDt	InsertDt	ActualStartDt	FinishedDt
Source	Staging		v
Source	Request	v	v	v	v

Voorbeeld 1

Zoeken op ProcessId en Body

{
  "ProcessIds": [
    1
  ],
  "Body": "Zaandam"
}

Voorbeeld 2

Binnen meerdere processen (op basis van ProcessId) zoeken of de body voor komt.

{
  "ProcessIds": [
    1,4,16
  ],
  "Body": "Zaandam"
}

Voorbeeld 3

Zoeken binnen twee processen, in een datum range, met een body, als source een request en waarbij de ActualStartDt niet leeg mag zijn.

{
  "ProcessIds": [
    1,2
  ],
  "Body": "Zundert",

  "DateTimes": [
    {
      "DateField": "ActualStartDt",
      "DateFrom": "2024-10-15",
      "DateTo": "2024-10-22",
      "AllowNull": false,
      "Source": "Request"
    }
  ]
}

Voorbeeld 4

Zoeken op een status kan alleen indien de status bij een Request of Staging hoort. Check het Type bij Spider statussen welke Request of Staging bevat.

{
  "ProcessIds": [
    2
  ],
  "StatusSet": [
    "RFN"
  ]
}

Geeft als response dat de status niet bekend is (is een Alarm status en hoort niet bij een Request/Staging status)

{
  "Message": "The request is invalid.",
  "ModelState": {
    "requestSearchFilter.StatusSet": [
      "Status with code 'ARN' is not supported"
    ]
  }
}

Voorbeeld 5

Zoeken op een ParentId binnen een Proces geeft alle request terug die aan dit ParentId gekoppeld zijn.

{
  "ProcessIds": [
    2
  ],
  "ParentIds": [
    55
  ]
}