List of application component templates

GET 
https://api.cloud.codenow.com/templates/application_components

The operation allows you to retrieve a collection of all available application component templates, which can be used to configure the template property of the ApplicationComponentCreateRequest.

Request

Header Parameters

X-Codenow-Api-Key anyrequired

CodeNOW API Key

Responses

200

List of application component templates

application/vnd.codenow.v1+json

Schema

Schema

• Array [

id stringrequired


The unique identifier of the library template.


version stringrequired


The currently provided version of the library template, using semantic versioning.


name stringrequired


The user-friendly name or label for the library template.


language stringrequired


The programming language supported by a library created from the template.


languageVersion stringrequired


The version of the programming language supported by a library created from the template.


description stringrequired


The textual description of the library template, which may provide some additional information in a user-friendly form.


buildSystem stringrequired


The name of the build system utilized by a library created from the template.


buildSystemVersion stringrequired


The version of the build system utilized by a library created from the template.


framework stringrequired


The name of the framework integrated with a library created from the template.


frameworkVersion stringrequired


The version of the framework integrated with a library created from the template.


custom booleanrequired


A boolean flag indicating whether the template is user-customized. If set to false, the template is provided by CodeNOW.


properties

object[]

required


A list of objects representing customizable template properties.


Array [

name stringrequired


The name of the property, also serving as the unique identifier or key.


description stringrequired


The textual description of the property, providing better understanding of the property's function or context in a user-friendly form.


type stringrequired


The required data type of the property's value.


required booleanrequired


A boolean flag indicating whether the property is mandatory. If set to false, the property may be omitted.


]

• ]

Example (from schema)

[
  {
    "id": "string",
    "version": "string",
    "name": "string",
    "language": "string",
    "languageVersion": "string",
    "description": "string",
    "buildSystem": "string",
    "buildSystemVersion": "string",
    "framework": "string",
    "frameworkVersion": "string",
    "custom": true,
    "properties": [
      {
        "name": "string",
        "description": "string",
        "type": "string",
        "required": true
      }
    ]
  }
]

400

The request was unacceptable, often due to missing a required parameter.

401

No valid API key provided.

403

The API key doesn't have permissions to perform the request.

404

Resource not found.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500

Something went wrong on CodeNOW's end.

• curl
• nodejs
• csharp
• java

• CURL

curl -L 'https://api.cloud.codenow.com/templates/application_components' \
-H 'Accept: application/vnd.codenow.v1+json'

Request Collapse all

Base URL

https://api.cloud.codenow.com

Parameters

X-Codenow-Api-Key — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!