Scale API | Application Specs › List Application Specs

Application Specs

application_specs

Methods

Create Application Spec ->

ApplicationSpec

post/v4/application-specs

Description

Creates a application spec

Details

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

Delete Application Spec ->

GenericDeleteResponse

delete/v4/application-specs/{application_spec_id}

Description

Deletes a application spec

Details

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

List Application Specs -> PageResponse<

ApplicationSpec

get/v4/application-specs

Description

Lists all application specs accessible to the user.

Details

This API can be used to list application specs. If a user has access to multiple accounts, all application specs 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

include_archived: boolean

Optional

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

PaginatedApplicationSpecs

Request example

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

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "description": "description",
      "name": "name",
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "run_online_evaluation": true,
      "theme_id": "theme_id"
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Application Spec ->

ApplicationSpec

get/v4/application-specs/{application_spec_id}

Description

Gets the details of a application spec

Details

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

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

Update Application Spec ->

ApplicationSpec

patch/v4/application-specs/{application_spec_id}

Description

Updates a application spec

Details

This API can be used to update the application spec 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 Spec API call as a path parameter.

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

Domain types

ApplicationSpec = { id, account_id, created_at, 6 more... }

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