Scale API | Application Variants › List Application Variants

Application Variants

application_variants

Methods

Create Application Variant -> { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... }

post/v4/application-variants

Description

Creates a application variant

Details

This API can be used to create a application variant. To use this API, review the request schema and pass in all fields that are required to create a application variant.

Delete Application Variant ->

GenericDeleteResponse

delete/v4/application-variants/{application_variant_id}

Description

Deletes a application variant

Details

This API can be used to delete a application variant by ID. To use this API, pass in the id that was returned from your Create Application Variant API call as a path parameter.

List Application Variants -> PageResponse<{ id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... }>

get/v4/application-variants

Description

Lists all application variants accessible to the user.

Details

This API can be used to list application variants. If a user has access to multiple accounts, all application variants from all accounts the user is associated with will be returned.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id: string

Optional

application_spec_id:

Optional

UnionMember0 = number

UnionMember1 = string

limit: number

Optional

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

page: number

Optional

Page number for pagination to be returned by the given endpoint. Starts at page 1

Response fields

PaginatedApplicationVariants

Request example

curl https://api.egp.scale.com/v4/application-variants \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "application_spec_id": "application_spec_id",
      "configuration": {
        "edges": [
          {
            "from_field": "from_field",
            "from_node": "from_node",
            "to_field": "to_field",
            "to_node": "to_node"
          }
        ],
        "nodes": [
          {
            "id": "id",
            "application_node_schema_id": "text_input_schema",
            "configuration": {
              "foo": {
                "value": {}
              }
            }
          }
        ],
        "guardrail_config": {
          "guardrails_to_execute": [
            "string"
          ]
        },
        "metadata": {}
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "draft": true,
      "name": "name",
      "version": "V0",
      "created_by_user_id": "created_by_user_id",
      "description": "description",
      "published_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Update Application Variant -> { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... }

patch/v4/application-variants/{application_variant_id}

Description

Updates a application variant

Details

This API can be used to update the application variant that matches the ID that was passed in as a path parameter. To use this API, pass in the id that was returned from your Create Application Variant API call as a path parameter.

Review the request schema to see the fields that can be updated.

Process Application By ID -> unknown

post/v4/applications/{application_variant_id}/process

Process Application By Id

Get Application Variant -> { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... } | { id, account_id, application_spec_id, 8 more... }

get/v4/application-variants/{application_variant_id}

Description

Gets the details of a application variant

Details

This API can be used to get information about a single application variant by ID. To use this API, pass in the id that was returned from your Create Application Variant API call as a path parameter.

Review the response schema to see the fields that will be returned.

Domain types

ApplicationAgentGraphNode = { id, name, type, 4 more... }

ApplicationConfiguration = { edges, nodes, guardrail_config, 1 more... }

ApplicationEdge = { from_field, from_node, to_field, 1 more... }

ApplicationNode = { id, application_node_schema_id, configuration }

PaginatedApplicationVariants = { current_page, items, items_per_page, 1 more... }