Virksomhedsindsats.JobAdBatchService (Version 1, 2023-4)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
- 1 UpdateJobAdStatusFromBatch (PUT /v1/JobAdBatch/updatestatus)
- 2 ArchiveToJobAdDeleted (PUT /v1/JobAdBatch/archivedeleted)
- 3 ArchiveJobAdStatus (PUT /v1/JobAdBatch/archivestatus)
- 4 CleanUpArchive (PUT /v1/JobAdBatch/cleanuparchive)
- 5 CleanupJobAd (PUT /v1/JobAdBatch/cleanupjobad)
- 6 GetJobAdsReadyToArchive (GET /v1/JobAdBatch/readytoarchive)
- 7 GetQueuedAnkiroEvents (GET /v1/JobAdBatch/ankiro-events)
- 8 DeleteQueuedAnkiroEvent (DELETE /v1/JobAdBatch/ankiro-event/{id})
- 9 RegisterActiveBatchJob (POST /v1/JobAdBatch/registeractivebatchjob)
- 10 DeleteActiveBatchJob (DELETE /v1/JobAdBatch/deleteactivebatchjob)
UpdateJobAdStatusFromBatch (PUT /v1/JobAdBatch/updatestatus)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | UpdateJobAdStatusFromBatchResponseDto |
| 1 |
|
- totalJobs | int32 |
| 1 |
|
- succeededJobs | int32 |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
ArchiveToJobAdDeleted (PUT /v1/JobAdBatch/archivedeleted)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
jobAdId [Query] | int32 |
| 1 |
|
isDeleteAutomatic [Query] | boolean |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
ArchiveJobAdStatus (PUT /v1/JobAdBatch/archivestatus)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
jobAdId [Query] | int32 |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
CleanUpArchive (PUT /v1/JobAdBatch/cleanuparchive)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
daysToKeepJobAds [Query] | int32 |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
CleanupJobAd (PUT /v1/JobAdBatch/cleanupjobad)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
jobAdId [Query] | int32 |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
GetJobAdsReadyToArchive (GET /v1/JobAdBatch/readytoarchive)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
daysToKeepJobAds [Query] | int32 |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetJobAdsReadyToArchiveResponseDto |
| 1 |
|
- jobAdIds | int32Collection |
| 1 |
|
- - int32 | int32 |
| 0 - * |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
GetQueuedAnkiroEvents (GET /v1/JobAdBatch/ankiro-events)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetQueuedAnkiroEventsResponseDto |
| 1 |
|
- events | QueuedAnkiroEventDtoCollection |
| 1 |
|
- - QueuedAnkiroEventDto | QueuedAnkiroEventDto |
| 0 - * |
|
- - - id | int32 |
| 1 |
|
- - - jobAdId | int32 |
| 1 |
|
- - - ankiroEvent | int32 |
| 1 |
|
- - - createdAt | date-time |
| 1 |
|
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
DeleteQueuedAnkiroEvent (DELETE /v1/JobAdBatch/ankiro-event/{id})
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | int32 |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
RegisterActiveBatchJob (POST /v1/JobAdBatch/registeractivebatchjob)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | RegisterActiveBatchJobRequestDto |
| 1 |
|
- batchJobName | string | Length: 1-50 | 1 |
|
- staleThresholdSeconds | int32 |
| 0 - 1 |
|
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |
120100 | Instance of batch job is already active. | Instance of batch job is already active. |
DeleteActiveBatchJob (DELETE /v1/JobAdBatch/deleteactivebatchjob)
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.batch.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
batchJobName [Query] | string | MaxLength: 255 | 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
120033 | Generel fejl | Generel fejl |