Skip to main content

Get an application component

GET 
/applications/:applicationId/components/:applicationComponentId

Gets a component detail for the specified application

Request​

Path Parameters

    applicationComponentId stringrequired

    Possible values: non-empty

    applicationId stringrequired

    Possible values: non-empty

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

application-components-get 200 response

Schema

    id stringrequired


    The unique identifier of the application component. Based on the user-defined name.

    name stringrequired


    Human readable name of the application component.

    description string


    The detailed textual description.

    applicationId stringrequired


    ID of the application this component is part of.

    state AppComponentState (string)required

    Possible values: [CREATING, READY, FAILED, DELETING]


    State of the application component.
    CREATING - Application component is in the process of being created.
    READY - Application component is ready to be used.
    FAILED - Application component creation has failed.
    DELETING - Application component is in the process of being deleted.

    runtimeId stringrequired


    Runtime id of the application component compatible with DNS-1123 label, based on id.
    It must be used in certain places such as kubernetes labels. (Might be the same as id.)

    template

    object

    required


    Template specification for the application component.

    id stringrequired

    Possible values: non-empty


    An internal identifier of the scaffold selected for library creation.
    It includes information about the selected language, build tool and framework, if specified.
    Available templates can be obtained through the:
    /templates/application_components endpoint for application component or
    /templates/libraries endpoint for library

    version stringrequired

    Possible values: non-empty


    The desired version of the selected template.

    Available templates can be obtained through the:
    /templates/application_components endpoint for application component or
    /templates/libraries endpoint for library

    properties

    object


    A map of properties ("key": "value") required for proper template configuration.

    Available templates can be obtained through the:
    /templates/application_components endpoint for application component or
    /templates/libraries endpoint for library

    property name* string

    scm

    object

    required


    An object containing Source Code Management (SCM) information, including provider, repository/project ID, HTTP clone URL, and SSH clone URL.

    provider stringnullable


    The name of the SCM provider associated with the library, facilitating version control and collaborative software development.

    providerType stringnullable


    CI Provider type (gihub, codenow, etx)

    id stringnullable


    The unique identifier of the library repository or project within the SCM system.

    sshAddress stringrequired


    The SSH address string required for performing a Git clone operation on the repository linked to the library.

    httpAddress stringrequired


    The HTTP address string required for performing a Git clone operation on the repository linked to the library.

    error

    object

    nullable


    Error details, if any, encountered during the library creation process.

    code string
    message string
    buildSystem stringnullable


    The name of the build system used for compiling, testing, and packaging code within the library.

    settings

    object

    Basic settings for the component

    contextPath string
    maxQueueSize int32

    ciSettings

    object

    CI settings for the component

    provider stringnullable


    Associated CI provider
    codenow - uses CodeNow CI
    external - uses external CI

    globalPipelinesConfiguration booleannullable


    A boolean flag indicating whether pipeline settings are globally configured for the entire repository. If set to false, the pipeline settings are independently customized for individual branches.

Loading...