Virksomhedsindsats.JobannonceBatchService (Version 1 [UDV], 2024-1)

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

email

 

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

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

int32

 

1

Id for indeks eventet

-    -    -    jobannonceId

int32

 

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.

-    -    -    indekseringsEventType

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

int32

 

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

email

 

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

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

XxXxXxX

Eventet kunne ikke findes

Eventet kunne ikke findes

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

email

 

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-255

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

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

120100

Instance of batch job is already active.

Instance of batch job is already active.

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

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

email

 

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

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

XxXxXxXx

Det aktive batchjob kunne ikke findes

Det aktive batchjob kunne ikke findes