Afficher la Table des Matières
Ce web service vous permet de rechercher les plannings correspondant aux critères renseignés.
Méthode : POST workforce/schedules/search
Exemple : {adresse du serveur Akuiteo}/{nom de l'application Akuiteo}/rest/workforce/schedules/search?from=01/01/2018 00: 00&to=05/06/2018 00: 00
Paramètre (body) :
{
"employeeCode": "CBU"
}
| Paramètre | Description | Valeur | Obligatoire ? |
|---|---|---|---|
actionCode
|
Code action |
Caractère alphanumérique 10 caractères max. Ex : ABS |
Non |
employeeCode
|
Code collaborateur |
Caractère alphanumérique 10 caractères max. Ex : DRI |
Non |
projectCode
|
Code affaire |
Caractère alphanumérique 10 caractères max. Ex : PRE0002458 |
Non |
phaseCode
|
Code lot |
Caractère alphanumérique 10 caractères max. Ex : ARCHI |
Non |
subPhaseCode
|
Code sous-lot |
Caractère alphanumérique 10 caractères max. Ex : ARCHI |
Non |
projectTaskCode
|
Code tâche |
Caractère alphanumérique 100 caractères max. Ex : Architecture |
Non |
comment
|
Commentaire |
Caractère alphanumérique 1000 caractères max. Ex : Prestation architecture sur site |
Non |
place
|
Lieu |
Caractère alphanumérique 40 caractères max. Ex : Meudon |
Non |
description
|
Description |
Caractère alphanumérique 40 caractères max. Ex : Numéro de demande XXX |
Non |
creationDateFrom
|
Date de création / Après le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 00 :00 |
Oui |
creationDateTo
|
Date de création / Avant le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 18 :00 |
Non |
modificationDateFrom
|
Date de modification / Après le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 00 :00 |
Non |
modificationDateTo
|
Date de modification / Avant le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 18 :00 |
Non |
validated
|
Validé ou non validé |
Booléen 0 = Non 1 = Oui |
Non |
[
{
"id": "500000300",
"projectId": "PRE20001",
"phase": {
"code": "ARC"
},
"date": "14/10/2018 22 :00",
"duration": 1,
"employee": {
"id": "500000011",
"code": "CBU"
},
"employeeId": "500000011",
"actionCode": {
"name": "TRA"
},
"comment": "ARC",
"changeTracking": {
"createdTime": "10/10/2018 15 :12",
"createdBy": {
"code": "CASH"
},
"modificationTime": "10/10/2018 15 :19",
"modificationBy": {
"code": "CASH"
}
}
}
]
Ce web service vous permet de créer un planning avec les critères renseignés.
Méthode : PUT workforce/schedules
Exemple : {Adresse du serveur Akuiteo}/{nom de l'application Akuiteo}/rest/workforce/schedules
Paramètre (body) :
{
"project": {
"id": "000DEVIS"
},
"customer": {
"code": "C100002"
},
"employee": {
"code": "VMIC"
},
"actionCode": {
"id": "TRA"
},
"projectTask": {
"name" : "Affaire devis générique"
},
"duration": "1.0",
"date": "06/11/2018 00 :00"
}
| Paramètre | Description | Valeur | Obligatoire ? |
|---|---|---|---|
actionCode
|
Code action |
Caractère alphanumérique 10 caractères max. Ex : ABS |
Oui |
employeeCode
|
Code collaborateur |
Caractère alphanumérique 10 caractères max. Ex : DRI |
Oui |
projectCode
|
Code affaire |
Caractère alphanumérique 10 caractères max. Ex : PRE0002458 |
Oui |
phaseCode
|
Code lot |
Caractère alphanumérique 10 caractères max. Ex : ARCHI |
Non |
subPhaseCode
|
Code sous-lot |
Caractère alphanumérique 10 caractères max. Ex : ARCHI |
Non |
projectTaskCode
|
Code tâche |
Caractère alphanumérique 100 caractères max. Ex : Architecture |
Oui |
comment
|
Commentaire |
Caractère alphanumérique 1000 caractères max. Ex : Prestation architecture sur site |
Oui |
place
|
Lieu |
Caractère alphanumérique 40 caractères max. Ex : Meudon |
Non |
duration
|
Durée |
Caractère alphanumérique 14 caractères max. Ex : 0.75 |
Oui |
date
|
Date de création |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 00 :00 |
Oui |
description
|
Description |
Caractère alphanumérique 40 caractères max. Ex : Numéro de demande XXX |
Non |
validated
|
Validé ou non validé |
Booléen 0 = Non 1 = Oui |
Non |
L'identification du planning créé.
| Message d'erreur | Description |
|---|---|
| Code action <codeAction> inexistant | Le code action renseigné n'existe pas. |
| Code affaire <codeAffaire> inexistant | Le code de l'affaire renseignée n'existe pas. |
| Code lot <codeLot> pour l’affaire <codeAffaire> inexistant | Le code du lot n'existe pas pour l'affaire renseignée. |
| Tâche <tache> pour l’affaire <codeAffaire> inexistante | Le code de la tâche n'existe pas pour l'affaire renseignée. |
| L’état de l’affaire <codeAffaire> ne permet pas la création de planning | Le code état de l'affaire renseignée ne permet pas de créer des plannings. |
| La date d’affectation <date> est en dehors des dates d’ouverture de l’affaire <codeAffaire> | La date d'affectation est en dehors des dates de début et de fin de l'affaire renseignée. |
| Collaborateur <codeCollaborateur> inexistant | Le collaborateur renseigné n'existe pas. |
| Date d’affectation <date> en dehors des date entrée et sortie du collaborateur <codeCollaborateur> | La date d'affectation est en dehors des dates d'entrée et de sortie du collaborateur renseigné. |
| Une affectation de planning existe déjà pour le collaborateur <codeCollaborateur> au <date> | Une affectation de planning existe déjà pour le collaborateur à la date d'affectation renseignée. |
Ce web service vous permet de supprimer les plannings correspondant aux critères renseignés.
Méthode : DELETE workforce/schedules
Exemple : {Adresse du serveur Akuiteo}/{nom de l'application Akuiteo}/rest/workforce/schedules?from=01/01/2018 00 :00&to=05/06/2018 00 :00
Paramètre (body) :
{
"employeeCode": "CBU"
}
| Paramètre | Description | Valeur | Obligatoire ? |
|---|---|---|---|
actionCode
|
Code action |
Caractère alphanumérique 10 caractères max. Ex : ABS |
Non |
employeeCode
|
Code collaborateur |
Caractère alphanumérique 10 caractères max. Ex : DRI |
Non |
projectCode
|
Code affaire |
Caractère alphanumérique 10 caractères max. Ex : PRE0002458 |
Non |
phaseCode
|
Code lot |
Caractère alphanumérique 10 caractères max. Ex : ARCHI |
Non |
subPhaseCode
|
Code sous-lot |
Caractère alphanumérique 10 caractères max. Ex : ARCHI |
Non |
projectTaskCode
|
Code tâche |
Caractère alphanumérique 100 caractères max. Ex : Architecture |
Non |
comment
|
Commentaire |
Caractère alphanumérique 1000 caractères max. Ex : Prestation architecture sur site |
Non |
place
|
Lieu |
Caractère alphanumérique 40 caractères max. Ex : Meudon |
Non |
description
|
Description |
Caractère alphanumérique 40 caractères max. Ex : Numéro de demande XXX |
Non |
creationDateFrom
|
Date de création / Après le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 00 :00 |
Oui |
creationDateTo
|
Date de création / Avant le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 18 :00 |
Non |
modificationDateFrom
|
Date de modification / Après le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 00 :00 |
Non |
modificationDateTo
|
Date de modification / Avant le |
Format de date JJ/MM/AAAA HH :mm Ex : 15/09/2018 18 :00 |
Non |
validated
|
Validé ou non validé |
Booléen 0 = Non 1 = Oui |
Non |
Le nombre d'entrées supprimées.
| Message d'erreur | Description |
|---|---|
| Demande <descriptif> inexistante | Le code du lot est renseigné mais le code de l'affaire est vide. |
| L’affaire et le lot doivent être renseignés pour le sous-lot <codeSousLot> | Le code du sous-lot est renseigné mais les codes de l'affaire et/ou du lot sont vides. |
| L’affaire doit être renseignée pour la tâche <tache> | Le code de la tâche est renseigné mais le code de l'affaire est vide. |
Suivez-nous !
