Siden opdateres automatisk til at afspejle koden.
Metoder
GetIndekseringsEvents (GET /v1/JobannonceBatch/indeksering)
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 |
---|---|---|---|---|
X-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | |
- organisationType | OrganisationTypeCodeList | 1 | ||
- organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | |
- requestUserStructure | RequestUserStructureDto | 1 | ||
- - userFullName | string | Length: 1-140 | 1 | |
- - requestUserType | RequestUserTypeCodeList | 1 | ||
- - userIdentifier | string | Length: 1-255 | 1 | |
- - userEmail | 0 - 1 | |||
- requestOrganisationStructure | RequestOrganisationStructureDto | 1 | ||
- - organisationType | OrganisationTypeCodeList | 1 | ||
- - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
- registrationDateTime | date-time | 1 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
response | GetIndekseringsEventsResponseDto | 1 | ||
- events | IndekseringsEventDtoCollection | 1 | Index events for de jobannoncer, som enten skal tilføjes, fjernes eller ændres i indekset. | |
- - IndekseringsEventDto | IndekseringsEventDto | 0 - * | ||
- - - id | uuid | 1 | Id for indeks eventet | |
- - - jobannonceId | uuid | 1 | Id for jobannoncen, som skal tilføjes, fjernes eller ændres i indekset. Kun et event kan eksistere pr. jobannonce, og dette er derfor unikt. | |
- - - type | IndekseringsEventTypeCodeList | 1 | ||
- - - oprettetTidspunkt | date-time | 1 | Tidspunktet for oprettelse af eventet. |
Fejlkoder
Ingen fejlkoder
DeleteIndekseringsEvent (DELETE /v1/JobannonceBatch/indeksering/{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] | uuid | 1 | ||
X-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | |
- organisationType | OrganisationTypeCodeList | 1 | ||
- organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | |
- requestUserStructure | RequestUserStructureDto | 1 | ||
- - userFullName | string | Length: 1-140 | 1 | |
- - requestUserType | RequestUserTypeCodeList | 1 | ||
- - userIdentifier | string | Length: 1-255 | 1 | |
- - userEmail | 0 - 1 | |||
- requestOrganisationStructure | RequestOrganisationStructureDto | 1 | ||
- - organisationType | OrganisationTypeCodeList | 1 | ||
- - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
- registrationDateTime | date-time | 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 |
---|---|---|
120506 | Indekserings-event blev ikke fundet. | Indekserings-event blev ikke fundet. |
CreateAktivtBatchjob (POST /v1/JobannonceBatch)
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-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | |
- organisationType | OrganisationTypeCodeList | 1 | ||
- organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | |
- requestUserStructure | RequestUserStructureDto | 1 | ||
- - userFullName | string | Length: 1-140 | 1 | |
- - requestUserType | RequestUserTypeCodeList | 1 | ||
- - userIdentifier | string | Length: 1-255 | 1 | |
- - userEmail | 0 - 1 | |||
- requestOrganisationStructure | RequestOrganisationStructureDto | 1 | ||
- - organisationType | OrganisationTypeCodeList | 1 | ||
- - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
- registrationDateTime | date-time | 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 | |
requestBody | CreateAktivtBatchjobRequestDto | 1 | ||
- navn | string | Length: 1-50 | 1 | Navn på batchjobbet, som nu er aktivt. |
- udloebSekunder | int32 | 0 - 1 | Antal sekunder før batchjobbets validitet udløber, og det kan erstattes af en ny instans (fx. ved stoppet batchjob uden fjernelse). |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
120511 | Batchjobbet kører allerede. | Batchjobbet kører allerede. |
DeleteAktivtBatchjob (DELETE /v1/JobannonceBatch/{navn})
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 |
---|---|---|---|---|
navn [Path] | string | MaxLength: 255 | 1 | |
X-ActiveOrganisation [Header] | ActiveOrganisationDto | 1 | Impersoneret myndighed | |
- organisationType | OrganisationTypeCodeList | 1 | ||
- organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
X-RequestUserMetadata [Header] | RequestUserMetadataDto | 1 | Kaldende myndighed | |
- requestUserStructure | RequestUserStructureDto | 1 | ||
- - userFullName | string | Length: 1-140 | 1 | |
- - requestUserType | RequestUserTypeCodeList | 1 | ||
- - userIdentifier | string | Length: 1-255 | 1 | |
- - userEmail | 0 - 1 | |||
- requestOrganisationStructure | RequestOrganisationStructureDto | 1 | ||
- - organisationType | OrganisationTypeCodeList | 1 | ||
- - organisationCode | string | Pattern: \d{1,8} MinLength: 1 | 1 | |
- registrationDateTime | date-time | 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 |
---|---|---|
120512 | Batchjobbet kører ikke. | Batchjobbet kører ikke. |