Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Catchpoint Systems TestTemplates API

The TestTemplates API from Catchpoint Systems — 4 operation(s) for testtemplates.

Catchpoint Systems TestTemplates API is one of 31 APIs that Catchpoint Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include TestTemplates. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 28 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, /api.

5 operations 4 paths 28 schemas 3 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://io.catchpoint.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Catchpoint Systems TestTemplates API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

TestTemplates 5
GET
/v2/testtemplates/{ids}
Returns Test Template details by the IDs passed.
1 param → 200
GET
/v2/testtemplates
Returns Test Template details by parameters passed.
2 params → 200
POST
/v2/testtemplates
Create a new test template based on the PostData.
1 param body → 200
PATCH
/v2/testtemplates/{id}
Update an existing test template based on the request body.
2 params body → 200
GET
/v2/testtemplates/applicationgroups
Returns the Application group enumeration details for automation.
→ 200

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TestTemplateAPIModel (19 properties), Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.FileReferenceAPIModel (12 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.TestTemplateResponseModel (6 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestTemplateResponseModel] (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.v2_0.TestTemplateResponseModel
object
6 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TemplatesDisplayConstructor.RequestSectionAPIModel
object
1 property
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TemplatesDisplayConstructor.TestDisplayConstructorAPIModel
object
2 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Nullable`1[System.Int32]]
object
2 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.FileReferenceAPIModel
object
12 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TestTemplateParameterAPIModel
object
4 properties
Catchpoint.Symphony.Enums.AccessLevel
integer
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationDetailResponse
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse
object
4 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TemplatesDisplayConstructor.AuthenticationSectionAPIModel
object
1 property
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TemplatesDisplayConstructor.ScriptSectionAPIModel
object
1 property
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TestTemplateAPIModel
object
19 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnumerationResponse]
object
6 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TestTemplateApplicationGroupAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TemplatesDisplayConstructor.DetailSectionAPIModel
object
3 properties
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.TestTypeSchemaAPIModel
object
3 properties
Catchpoint.Symphony.Enums.ObjectType
integer
Catchpoint.Symphony.REST.Common.Models.v2_0.TestTemplate.AssociatedRestrictedTestTemplateAPIModel
object
4 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.TestTemplateResponseModel]
object
6 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-systems-testtemplates-api-openapi.yml Raw ↑

Other APIs Catchpoint Systems publishes across the network.

Catchpoint Systems Account API
Catchpoint Systems Alerts API
Catchpoint Systems ASNs API
Catchpoint Systems Assertions API
Catchpoint Systems CommandControl API
Catchpoint Systems Contacts API
Catchpoint Systems Credentials API
Catchpoint Systems Divisions API
Catchpoint Systems EndpointDevice API
Catchpoint Systems EndpointDevicePerformance API
Catchpoint Systems Folder API
Catchpoint Systems Insights API