Start Today

← Documentation

get all projects

Prerequisites: none

Input parameters: none

Output parameters:

Field nameDescriptionFormat
elementsContainer - see belowProjectDto
totalTotal number of projects retrievedInteger

ProjectDto:

Field name

    **Description**
  


  

    **Format**
  










  

    **id**
  


  

    Project id
  


  

    UUID
  






  

    **name**
  


  

    Project name
  


  

    String
  






  

    **createdAt**
  


  

    Date-time of project creation
  


  

    Instant
  






  

    **modifiedAt**
  


  

    Date-time of project modification
  


  

    Instant
  






  

    **modifiedBy**
  


  

    User who modified the project
  


  

    String
  






  

    **description**
  


  

    Project description
  


  

    String
  






  

    **bookmarked**
  


  

    Indicator if this is a favorite project
  


  

    Boolean
  






  

    **additionalInfo**
  


  

    Container - see below
  


  

    ProjectAdditionalInfo
  






  

    **version**
  


  

    Project version number
  


  

    Integer
  






  

    **versions**
  


  

    Container - see below
  


  

    Map
  






  

    **deploymentImage**
  


  

    If project is deployed, the no-code docker image of the project; otherwise null
  


  

    String
  






  

    **technology**
  


  

    Set of options currently supported in OL Hub project:\
    HTTP, IBM\_MQ, KAFKA, DB\_POLLER, CORBA, SFTP, ACTIVE\_MQ, SOAP, REVERSE
  


  

    ApiEnrichmentType
  






  

    **configurations**
  


  

    Container - see below
  


  

    Set

ProjectAdditionalInfo:

Field nameDescriptionFormat
numofModulesNumber of modules in projectInteger
numofAssetsNumber of assets in projectInteger
numofMethodsNumber of methods in projectInteger
contractNameContract nameString
contractIDContract identifierUUID

Map:

Field nameDescriptionFormat
versionProject version numberInteger
ProjectVersionDtoContainer - see belowProjectVersion

ProjectVersion:

Field nameDescriptionFormat
projectIdProject idUUID
versionProject version numberInteger
reasonReason for project versionString
versionedByUser who versioned the projectString
versionedAtDate-time of project versionInstant

Read more