Project Template
List project templates
API call to list project templates.
Use the query parameters below to refine your search criteria for project templates:
- name - The full project template name or a portion of it. For example, using
name=GUI
orname=02
will locate project templates namedGUI02
. - clientId - The client’s ID within the system, not interchangeable with its UID.
- clientName - The complete or partial name of the client. For instance, using
clientName=GUI
orclientName=02
will find project templates associated with the clientGUI02
. - ownerUid - The user UID who owns the project template within the system, interchangeable with its ID.
- domainName - The complete or partial name of the domain. Using
domainName=GUI
ordomainName=02
will find project templates associated with the domainGUI02
. - subDomainName - The complete or partial name of the subdomain. For instance, using
subDomainName=GUI
orsubDomainName=02
will locate project templates linked to the subdomainGUI02
. - costCenterId - The cost center’s ID within the system, not interchangeable with its UID.
- costCenterName - The complete or partial name of the cost center. For example, using
costCenterName=GUI
orcostCenterName=02
will find project templates associated with the cost centerGUI02
. - businessUnitName - The complete or partial name of the business unit. For instance, using
businessUnitName=GUI
orbusinessUnitName=02
will locate project templates linked to the business unitGUI02
. - sort - Determines if the resulting list of project templates should be sorted by their names or the date they
were created. This field supports either
dateCreated
ortemplateName
as values. - direction - Indicates the sorting order for the resulting list by using either
asc
(ascending) ordesc
(descending) values. - pageNumber - Indicates the desired page number (zero-based) to retrieve. The total number of pages is returned in
the
totalPages
field within each response. - pageSize - Indicates the page size, affecting the
totalPages
retrieved in each response and potentially impacting the number of iterations needed to obtain all project templates.
GET
List project templates
Query Parameters
Required range:
x >= 0
Available options:
templateName
, dateCreated
, clientName
, businessUnitName
, domainName
, subdomainName
, createdBy
, owner
, sourceLang
Page number, starting with 0, default 0
Required range:
x >= 0
Page size, accepts values between 1 and 50, default 50
Required range:
1 <= x <= 50
Response
200
application/json
successful operation
The response is of type object
.
List project templates