types

GET

Retrieves all of the Types of things configured in Traffic Ops. Yes, that is as specific as a description of a ‘type’ can be.

Auth. Required

Yes

Roles Required

None

Response Type

Array

Request Structure

Table 255 Request Query Parameters

Name

Required

Description

id

no

Return only the type that is identified by this integral, unique identifier

name

no

Return only types with this name

useInTable

no

Return only types that are used to identify the type of the object stored in the Traffic Ops database table that has this name

#586 Request Structure
GET /api/3.0/types?name=TC_LOC HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

description

A short description of this type

id

An integral, unique identifier for this type

lastUpdated

The date and time at which this type was last updated, in Traffic Ops’s Custom Date/Time Format

name

The name of this type

useInTable

The name of the Traffic Ops database table that contains objects which are grouped, identified, or described by this type

#587 Response Example
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: EH8jo8OrCu79Tz9xpgT3YRyKJ/p2NcTmbS3huwtqRByHz9H6qZLQjA59RIPaVSq3ZxsU6QhTaox5nBkQ9LPSAA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 12 Dec 2018 22:59:22 GMT
Content-Length: 168

{ "response": [
    {
        "id": 48,
        "lastUpdated": "2018-12-12 16:26:41+00",
        "name": "TC_LOC",
        "description": "Location for Traffic Control Component Servers",
        "useInTable": "cachegroup"
    }
]}

POST

Creates a type

Auth. Required

Yes

Roles Required

“admin” or “operations”

Response Type

Object

Request Structure

description

A short description of this type

name

The name of this type

useInTable

The name of the Traffic Ops database table that contains objects which are grouped, identified, or described by this type.

Note

The only useInTable value that is allowed to be created dynamically is ‘server’

#588 Request Structure
POST /api/3.0/type HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 67
Content-Type: application/json

{
    "name": "Example01",
    "description": "Example",
    "useInTable": "server"
}

Response Structure

description

A short description of this type

id

An integral, unique identifier for this type

lastUpdated

The date and time at which this type was last updated, in Traffic Ops’s Custom Date/Time Format

name

The name of this type

useInTable

The name of the Traffic Ops database table that contains objects which are grouped, identified, or described by this type

#589 Response Example
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: EH8jo8OrCu79Tz9xpgT3YRyKJ/p2NcTmbS3huwtqRByHz9H6qZLQjA59RIPaVSq3ZxsU6QhTaox5nBkQ9LPSAA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 26 Feb 2020 18:58:41 GMT
Content-Length: 171

{
    "alerts": [
    {
        "text": "type was created.",
        "level": "success"
    }],
    "response": [
    {
        "id": 3004,
        "lastUpdated": "2020-02-26 18:58:41+00",
        "name": "Example01",
        "description": "Example"
        "useInTable": "server"
    }]
}