Sign in
organizations

Mettre à jour une organisation

Changed on
patch/api/v2/organizations/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/auth, token URL http://localhost:8082/realms/referentiel-applications/protocol/openid-connect/token)
    • API key in header x-refapp-token

Path parameters

idstring required

Request body

pathstring

Nom de l'organisation

urlstring

url de l'organisation

siglestring

sigle de l'organisation

parentIdstring

L'identifiant de l'organisation parente

businessDivisionIdstring nullable

L'identifiant de la direction métier associée (null pour détacher)

Example request

{
  "path": "Direction de la transformation numérique",
  "sigle": "dtnum",
  "parentId": "f09ed26a-8415-476a-be3b-ada479291c34",
  "businessDivisionId": "f09ed26a-8415-476a-be3b-ada479291c34"
}

Response

Organisation mise à jour

idstring required

L'identifiant de l'organisation

pathstring required

Nom de l'organisation

urlstring nullable required

url de l'organisation

siglestring nullable required

sigle de l'organisation

parentIdstring nullable required

L'identifiant de l'organisation parente

businessDivisionIdstring nullable required

L'identifiant de la direction métier associée

Example response

{
  "id": "f09ed26a-8415-476a-be3b-ada479291c34",
  "path": "Direction de la transformation numérique",
  "sigle": "dtnum",
  "parentId": "f09ed26a-8415-476a-be3b-ada479291c34",
  "businessDivisionId": "f09ed26a-8415-476a-be3b-ada479291c34",
  "businessDivision": {
    "label": "farm"
  },
  "maiaReferences": [
    {
      "id": "f09ed26a-8415-476a-be3b-ada479291c34",
      "maiaRef": "MI/DNUM/SDID",
      "organizationId": "f09ed26a-8415-476a-be3b-ada479291c34"
    }
  ]
}

Changes

  • 1fffb2d3f8b9Revision changes
    • breaking

      added the pattern \S to the request property

    • info

      added the non-success response with the status

  • 69ebe791b8cbRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status