Skip to main content

API Release 2.0.0-beta.11 - 19-09-2024

rules
  • Updated

Added endpoints

Business units

POST /api/v2/business-units/{business-unit-id}/users/{user-id}
  • Assigns a user to a business unit.
DELETE /api/v2/business-units/{business-unit-id}/users/{user-id}
  • Removes a member from a business unit.
PUT /api/v2/business-units/{business-unit-id}/users/bulk
  • Adds users to a business unit.

Components

DELETE /api/v2/components/{component-id}/visibility/users/{user-id}
  • Stops sharing a project component with a specific user.

Projects

POST /api/v2/projects/{project-id}/workflow-states/next
  • Update the workflow state of a project to the previous state
DELETE /api/v2/projects/{project-id}/ownership/users/{user-id}
  • Removes the user as owner of a project based on it id.
GET /api/v2/projects/export/list
  • Export a list of projects as an XLSX file.
POST /api/v2/projects/{project-id}/ownership/users/{user-id}
  • Add a user as owner of a project based on it id.
POST /api/v2/projects/{project-id}/workflow-states/previous
  • Update the workflow state of a project to the previous state

Roles

DELETE /api/v2/roles/{role-id}/users/{user-id}
  • Deletes a role from a user.
POST /api/v2/roles/{role-id}/users/{user-id}
  • Adds a role to a user.

Trust Zones

POST /api/v2/trust-zones/{trust-zone-id}/visibility/business-units
  • Shares a trust zone with a new business unit.
DELETE /api/v2/trust-zones/{trust-zone-id}/visibility/business-units/{business-unit-id}
  • Stops sharing a trust zone with a specific business unit.
GET /api/v2/trust-zones/{trust-zone-id}/visibility/business-units
  • Gets the list of business units with whom a trust zone is shared.

User Profile

PUT /api/v2/user-profile/avatar
  • Updates the avatar for the currently logged user.
DELETE /api/v2/user-profile/avatar
  • Deletes the avatar for the currently logged user.

Users

GET /api/v2/users/{user-id}/avatar
  • Gets the avatar of the requested user.
DELETE /api/v2/users/{user-id}/business-units/{business-unit-id}
  • Removes a member from a business unit.
PUT /api/v2/users/{user-id}
  • Updates the information of the user.
POST /api/v2/users/{user-id}/api-token/generate
  • Generates a token to use in the API for the requested user.
DELETE /api/v2/users/{user-id}
  • Deletes the user passed as param.
DELETE /api/v2/users/{user-id}/sessions
  • Deletes all the sessions of a user.
PUT /api/v2/users/{user-id}/avatar
  • Modifies the avatar for a given user.
POST /api/v2/users/{user-id}/business-units/{business-unit-id}
  • Assigns a user to a business unit.
POST /api/v2/users/{user-id}/disable
  • Disables the user passed as param.
DELETE /api/v2/users/{user-id}/roles/{role-id}
  • Deletes a role from a user.
POST /api/v2/users/{user-id}/roles/{role-id}
  • Adds a role to a user.
DELETE /api/v2/users/{user-id}/avatar
  • Deletes the user avatar for a given user.
POST /api/v2/users/{user-id}/enable
  • Enables the user passed as param.
GET /api/v2/users/{user-id}/business-units
  • Gets the business units the requested user is assigned to.
GET /api/v2/users/{user-id}/sessions/count
  • Gets the number of active sessions of a user.
POST /api/v2/users/{user-id}/reset-password-email/send
  • Sends an email to the user with a link to reset the password.
DELETE /api/v2/users/{user-id}/api-token
  • Deletes the token used in the API for the requested user.
GET /api/v2/users/{user-id}/roles
  • Gets the set of roles for a user.
GET /api/v2/users/{user-id}
  • Gets information about the requested user.

Removed endpoints

Business units

POST /api/v2/business-units/{business-unit-id}/users/{username}
  • Assigns a user to a business unit.
DELETE /api/v2/business-units/{business-unit-id}/users/{username}
  • Removes a member from a business unit.

Components

DELETE /api/v2/components/{component-id}/visibility/users/{username}
  • Stops sharing a project component with a specific user.

Projects

POST /api/v2/projects/{project-id}/ownership/users/{username}
  • Add a user as owner of a project based on it id.
DELETE /api/v2/projects/{project-id}/ownership/users/{username}
  • Removes the user as owner of a project based on it id.

Roles

DELETE /api/v2/roles/{role-id}/users/{username}
  • Deletes a role from a user.
POST /api/v2/roles/{role-id}/users/{username}
  • Adds a role to a user.

Users

POST /api/v2/users/{username}/business-units/{business-unit-id}
  • Assigns a user to a business unit.
DELETE /api/v2/users/{username}
  • Delete the user passed as param
GET /api/v2/users/{username}/avatar
  • Gets the avatar of the requested user.
DELETE /api/v2/users/{username}/sessions
  • Deletes all the sessions of a user.
GET /api/v2/users/{username}/roles
  • Get the set of roles for a user.
GET /api/v2/users/{username}/business-units
  • Get the business units the requested user is assigned to.
DELETE /api/v2/users/{username}/roles/{role-id}
  • Deletes a role from a user.
POST /api/v2/users/{username}/disable
  • Disable the user passed as param
DELETE /api/v2/users/{username}/api-token
  • Deletes the token used in the API for the requested user.
POST /api/v2/users/{username}/enable
  • Enable the user passed as param
POST /api/v2/users/{username}/roles/{role-id}
  • Adds a role to a user.
POST /api/v2/users/{username}/reset-password-email/send
  • Sends an email to the user with a link to reset the password.
PUT /api/v2/users/{username}
  • Replace information of the user.
GET /api/v2/users/{username}
  • Get information about the requested user.
DELETE /api/v2/users/{username}/business-units/{business-unit-id}
  • Removes a member from a business unit.
GET /api/v2/users/{username}/sessions/count
  • Get the number of active sessions of a user.
POST /api/v2/users/{username}/api-token/generate
  • Generates a token to use in the API for the requested user.

Changed parameters

GET /api/v2/projects/{project-id}/artifacts/current

  • The parameter 
    size
    has been added.
  • The parameter 
    version
    is not required anymore.

GET /api/v2/projects/artifacts/{artifact-id}

  • The parameter 
    size
    has been added.

GET /api/v2/templates/{template-id}/artifacts/current

  • The parameter 
    size
    has been added.

GET /api/v2/templates/artifacts/{artifact-id}

  • The parameter 
    size
    has been added.

Changed request bodies

PUT /api/v2/trust-zones/{trust-zone-id}

  • The property 
    sharedWithAllUsers
    has been added.

POST /api/v2/libraries

  • The property 
    referenceId
    has been added.

PUT /api/v2/user-profile/password

  • The property 
    currentPassword
    is now required.
  • The property 
    newPassword
    is now required.

POST /api/v2/trust-zones

  • The property 
    sharedWithAllUsers
    has been added.

API Specification

Related articles

Comments

0 comments

Article is closed for comments.

Powered by Zendesk