Parametrage des Sections Analytiques

Présentation générale de l'API et finalité fonctionnelle

Cette API permet d'interagir avec les sections crées sur un dossier :

• Interrogation
• Ajout
• Modification
• Suppression

GET/section

Description

Cette API permet la récupération des sections créées sur un dossier :

Lien vers la documentation technique

Cas d'usage

• Récupération de l'ensemble des informations des sections d'un dossier en vue d'une modification future si nécessaire

Procédure

Il faut appeler un endpoint :

https://api.cegid.com/loop-api-publiques/section?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Route	Méthode http	Description
/section	GET	Retourne la liste des sections du dossier

Paramétrage de l’appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Description	Obligatoire	Exemple
Fields1	Valeur à renseigner : Code Dossier	Oui	CEGID001
filter	Permet de filtrer le resultat	Non
sort	Trie le résultat	Non
skip	Saute X dossiers	Non
take	Retourne X dossiers	Non

Code retour

En cas de succès :

Code retour http de la réponse : 200

En cas d'échec :

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour :

L'API retourne une liste d'objet suivant : |Champ |Sous champ | Type | Description | | :- | :- | :- |:-| |objectId||string($uuid)|ID (UUID) Code unique de la section |revisionId||string($uuid)| ID (UUID) de la révision de la section | description||string | Description de la section | |code string| |string| Code de la section|| | | ferme ||boolean | "false" ou "true" | | | axe ||| ||objectId|string($uuid) | ID (UUID) Code unique de l'axe
||description | string | Description de l'axe|

Exemple de réponse

[
    {
    "objectId": "37f8728f-af7a-46e7-b690-668e810208ae",
    "revisionId": "0x0000000000033A12",
    "description": "SECTION D'ATTENTE AXEANAAXE",
    "code": "SECA@AXE",
    "ferme": false,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28",
      "description": [
        "Axe 1"
      ]
    }
  }
   ]

POST/section

Description

Cette API permet la création de sections dans un dossier :

Lien vers la documentation technique

Cas d'usage

• Création d'une ou plusieurs sections sur un dossier

Procédure

Prérequis :

Attention, avant d'exécuter la requete "POST", il est nécessaire d'éxécuter un "GET" afin d'obtenir l'objectId de l'axe.

Il faut appeler un endpoint :

https://api.cegid.com/loop-api-publiques/section?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Route	Méthode http	Description
/section	POST	Création de nouvelles sections

Paramétrage de l’appel

Méthode http pour la demande : POST

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Description	Obligatoire	Exemple
Fields1	Valeur à renseigner : Code Dossier	Oui	CEGID001

Body de la demande | Champ | Sous champ|Type| Description | Obligatoire | | :- | :- | :- |:-|:-| |code| |string| Code de la section| Oui | | description||string | Description de la section |Oui| | ferme ||boolean | "false" ou "true" | | | axe ||| ||objectId|string($uuid) | ID (UUID) Code unique de l'axe

Exemple de body

[
  {
    "code": "speedway",
    "description": "speedway",
    "ferme": false,
    "axe": {
      "objectId": "8243ae67-19ae-47ea-b20c-a1ac079af76f"
    }
  }
]

Code retour

En cas de succès :

Code retour http de la réponse : 200

En cas d'échec :

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour :

L'API retourne une liste d'objet suivant :

Champ	Sous champ	Type	Description
revisionId		string($uuid)	ID (UUID) de la révision de la section
objectId		string($uuid)	ID (UUID) Code unique de la section
code		string	Code de la section
description		string	Description de la section
ferme		boolean	"false" ou "true"
axe
	objectId	string($uuid)	ID (UUID) Code unique de l'axe
	description	string	Description de l'axe
created		date	Date de création de la section AAAA-MM-JJ
Updated		date	Date de modification de la section AAAA-MM-JJ

Exemple de réponse

[
  {
    "revisionId": "0x00000000000B6242",
    "objectId": "ebb90730-db57-4846-ad94-39aa695e0a80",
    "code": "speedway",
    "description": "speedway",
    "ferme": false,
    "axe": {
      "objectId": "8243ae67-19ae-47ea-b20c-a1ac079af76f"
    },
    "created": "2024-05-27T14:52:32Z",
    "updated": "2024-05-27T14:52:32Z"
  }
]

PUT/section

Description

Cette API permet de modifier les informations des sections dans un dossier :

Lien vers la documentation technique

Cas d'usage

• modification du code et/ou de la description d'une ou plusieurs sections sur un dossier.

Procédure

Prérequis :

• Attention, avant d'exécuter la requete "PUT", il est nécessaire d'éxécuter un "GET" afin d'obtenir l'objectId de l'axe et le revisionId.
• Une section d'attente de type **SECA@XXXX** n'est pas modifiable
• Cette API permet de modifier la valeur d'un champ mais NE PERMET PAS de la supprimer. Envoyer une valeur à vide ne supprimera pas la valeur précédente

Il faut appeler un endpoint :

https://api.cegid.com/loop-api-publiques/section?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Route	Méthode http	Description
/section	PUT	modification de sections

Paramétrage de l’appel

Méthode http pour la demande : PUT

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Description	Obligatoire	Exemple
Fields1	Valeur à renseigner : Code Dossier	Oui	CEGID001

Body de la demande | Champ | Sous champ|Type| Description | Obligatoire | | :- | :- | :- |:-|:-| |code| |string| Code de la section| Oui | | description||string | Description de la section |Oui| | ferme ||boolean | "false" ou "true" | | | axe ||| ||objectId|string($uuid) | ID (UUID) Code unique de l'axe

Exemple de body

[
  {
    "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "revisionId": "string",
    "code": "speedway1",
    "description": "speedway1",
    "ferme": false,
    "axe": {
      "objectId": "8243ae67-19ae-47ea-b20c-a1ac079af76f"
    }
  }
]

Code retour

En cas de succès :

Code retour http de la réponse : 200

En cas d'échec :

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour :

L'API retourne une liste d'objet suivant :

Champ	Sous champ	Type	Description
objectId		string($uuid)	ID (UUID) Code unique de la section
revisionId		string($uuid)	ID (UUID) de la révision de la section
code		string	Code de la section
description		string	Description de la section
ferme		boolean	"false" ou "true"
axe
	objectId	string($uuid)	ID (UUID) Code unique de l'axe
updated		date	Date de modification de la section AAAA-MM-JJ

Exemple de réponse

[
  {
    {
    "objectId": "ebb90730-db57-4846-ad94-39aa695e0a80",
    "revisionId": "0x00000000000B8151",
    "description": "speedway99",
    "code": "speedway99",
    "ferme": false,
    "axe": {
      "objectId": "8243ae67-19ae-47ea-b20c-a1ac079af76f"
    },
    "updated": "2024-05-28T13:54:44Z"
  }
  }
]

DEL/section

Description

Cette API permet la suppression de sections dans un dossier :

Lien vers la documentation technique

Cas d'usage

• suppression d'une ou plusieurs sections non mouvementées sur un dossier

Procédure

Prérequis :

• Attention, avant d'exécuter la requete "DELETE", il est nécessaire d'éxécuter un "GET" afin d'obtenir l'objectId de l'axe et le revisionId.
• Les sections d'attente de type **SECA@XXXX** et les sections déja mouvementées sur un dossier ne seront pas supprimables

Il faut appeler un endpoint :

https://api.cegid.com/loop-api-publiques/section?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Route	Méthode http	Description
/section	DELETE	Suppression de sections

Paramétrage de l’appel

Méthode http pour la demande : DELETE

Header(s) attendu(s) obligatoire(s) de la demande

Champ	Description
Ocp-Apim-Subscription-Key	Subscription key
x-apikey	API Key & Secret

Paramètres de la demande

Champ	Description	Obligatoire	Exemple
Fields1	Valeur à renseigner : Code Dossier	Oui	CEGID001

Exemple de body

[
  {
    "objectId": "ebb90730-db57-4846-ad94-39aa695e0a80",
    "revisionId": "0x00000000000B8151",
    "description": "speedway99",
    "code": "speedway99",
    "ferme": false,
    "axe": {
      "objectId": "8243ae67-19ae-47ea-b20c-a1ac079af76f",
      "description": [
        "DEL"
      ]
    }
  }
]

Code retour

En cas de succès :

Code retour http de la réponse : 200

En cas d'échec :

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour :

L'API retourne une liste d'objet suivant :

Champ	Sous champ	Type	Description
objectId		string($uuid)	ID (UUID) Code unique de la section
revisionId		string($uuid)	ID (UUID) de la révision de la section
description		string	Description de la section
code		string	Code de la section
ferme		boolean	"false" ou "true"
axe
	objectId	string($uuid)	ID (UUID) Code unique de l'axe

Exemple de réponse

[
  {
    "objectId": "ebb90730-db57-4846-ad94-39aa695e0a80",
    "revisionId": "0x00000000000B6242",
    "description": "speedway99",
    "code": "speedway99",
    "ferme": false,
    "axe": {
      "objectId": "8243ae67-19ae-47ea-b20c-a1ac079af76f"
    }
  }
]