API docs by Redocly

Documentation de l'api taskApi (1.0.0)

Download OpenAPI specification:Download

Terms of Service

Documentation et contrat d'interface pour l'api taskApi, l'api responsable de la géstion de tâches à gérer par l'administration zorni.

task

addTask

création d'une tâche au tant qu'objet métier.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie une tâche.

resources
string
Enum: "PERSON" "ESTABLISHMENT" "ORGANIZATION"

Resource metier concernée par l'upload file.

openingDate
string <date-time>

date d'ouverture de la tache

closingDate
string <date-time>

date de cloture de la tache

status
string
Enum: "WAITTING_FOR_TREATMENT" "IN_PROGRESS" "FINISHED"

Resource metier concernée par l'upload file.

comment
string

commentaire de l'admin après traitement de la tâche.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "resources": "PERSON",
  • "openingDate": "2019-08-24T14:15:22Z",
  • "closingDate": "2019-08-24T14:15:22Z",
  • "status": "WAITTING_FOR_TREATMENT",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "resources": "PERSON",
  • "openingDate": "2019-08-24T14:15:22Z",
  • "closingDate": "2019-08-24T14:15:22Z",
  • "status": "WAITTING_FOR_TREATMENT",
  • "comment": "string",
  • "links": [
    ]
}

listTask

Lister les tâches.

query Parameters
currentPage
integer >= 1

le numéro de la page actuelle, si 1er appel ne pas envoyer cet attribut.

sizePage
integer >= 3

Nombre d'éléments par page.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "currentPage": 0,
  • "content": [
    ]
}

getTask

récupération d'une tâche par son id.

path Parameters
task-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "resources": "PERSON",
  • "openingDate": "2019-08-24T14:15:22Z",
  • "closingDate": "2019-08-24T14:15:22Z",
  • "status": "WAITTING_FOR_TREATMENT",
  • "comment": "string",
  • "links": [
    ]
}

putTask

modification d'une personne.

path Parameters
task-id
required
string

id technique du personne.

header Parameters
X-Correlation-ID
string

Identifiant de corrélation

Request Body schema: application/json
id
string

id technique et unique généré automatiquement et qui identifie une tâche.

resources
string
Enum: "PERSON" "ESTABLISHMENT" "ORGANIZATION"

Resource metier concernée par l'upload file.

openingDate
string <date-time>

date d'ouverture de la tache

closingDate
string <date-time>

date de cloture de la tache

status
string
Enum: "WAITTING_FOR_TREATMENT" "IN_PROGRESS" "FINISHED"

Resource metier concernée par l'upload file.

comment
string

commentaire de l'admin après traitement de la tâche.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "resources": "PERSON",
  • "openingDate": "2019-08-24T14:15:22Z",
  • "closingDate": "2019-08-24T14:15:22Z",
  • "status": "WAITTING_FOR_TREATMENT",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "resources": "PERSON",
  • "openingDate": "2019-08-24T14:15:22Z",
  • "closingDate": "2019-08-24T14:15:22Z",
  • "status": "WAITTING_FOR_TREATMENT",
  • "comment": "string",
  • "links": [
    ]
}