Profiles

Basic Profile Operations

---

Profile CRUD Operations

get

Authorizations

knoxApiToken

Query parameters

specificationstringOptional

Responses

200Success

application/json

get

/prod/v0/profiles/

HTTPcURLJavaScriptPython

GET /prod/v0/profiles/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": 1,
    "tags": [
      {
        "id": 1,
        "name": "text",
        "description": "text"
      }
    ],
    "specification": "text",
    "template": {
      "id": 1,
      "name": "text",
      "description": "text",
      "fields": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        }
      ],
      "questions": [
        "text"
      ]
    },
    "snapshots": [
      {
        "id": 1,
        "status": "text",
        "answers": [
          {
            "id": 1,
            "answer": null
          }
        ],
        "fields": [
          {
            "id": 1,
            "field": {
              "id": 1,
              "name": "text",
              "description": "text",
              "type": "text",
              "rel_template": 1,
              "enum_values": [
                "text"
              ],
              "enum_many": true,
              "sources": [
                "text"
              ]
            },
            "status": "text",
            "value": null
          }
        ],
        "reports": [
          {
            "id": 1,
            "outline": {
              "id": 1,
              "outline": null,
              "perspective": "text"
            },
            "report": null
          }
        ]
      }
    ]
  }
]

post

Authorizations

knoxApiToken

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerRead-onlyRequired

template_idintegerWrite-onlyRequired

specificationstring · max: 510Required

templateall ofRead-onlyRequired

Responses

201Success

application/json

post

/prod/v0/profiles/

HTTPcURLJavaScriptPython

POST /prod/v0/profiles/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "template_id": 1,
  "tags": [
    {
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": 1,
  "tags": [
    {
      "id": 1,
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text",
  "template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "snapshots": [
    {
      "id": 1,
      "status": "text",
      "answers": [
        {
          "id": 1,
          "answer": null
        }
      ],
      "fields": [
        {
          "id": 1,
          "field": {
            "id": 1,
            "name": "text",
            "description": "text",
            "type": "text",
            "rel_template": 1,
            "enum_values": [
              "text"
            ],
            "enum_many": true,
            "sources": [
              "text"
            ]
          },
          "status": "text",
          "value": null
        }
      ],
      "reports": [
        {
          "id": 1,
          "outline": {
            "id": 1,
            "outline": null,
            "perspective": "text"
          },
          "report": null
        }
      ]
    }
  ]
}

get

Authorizations

knoxApiToken

Path parameters

idintegerRequired

A unique integer value identifying this profile.

Responses

200Success

application/json

get

/prod/v0/profiles/{id}/

HTTPcURLJavaScriptPython

GET /prod/v0/profiles/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": 1,
  "tags": [
    {
      "id": 1,
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text",
  "template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "snapshots": [
    {
      "id": 1,
      "status": "text",
      "answers": [
        {
          "id": 1,
          "answer": null
        }
      ],
      "fields": [
        {
          "id": 1,
          "field": {
            "id": 1,
            "name": "text",
            "description": "text",
            "type": "text",
            "rel_template": 1,
            "enum_values": [
              "text"
            ],
            "enum_many": true,
            "sources": [
              "text"
            ]
          },
          "status": "text",
          "value": null
        }
      ],
      "reports": [
        {
          "id": 1,
          "outline": {
            "id": 1,
            "outline": null,
            "perspective": "text"
          },
          "report": null
        }
      ]
    }
  ]
}

put

Authorizations

knoxApiToken

Path parameters

idintegerRequired

A unique integer value identifying this profile.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerRead-onlyRequired

template_idintegerWrite-onlyRequired

specificationstring · max: 510Required

templateall ofRead-onlyRequired

Responses

200Success

application/json

put

/prod/v0/profiles/{id}/

HTTPcURLJavaScriptPython

PUT /prod/v0/profiles/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "template_id": 1,
  "tags": [
    {
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": 1,
  "tags": [
    {
      "id": 1,
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text",
  "template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "snapshots": [
    {
      "id": 1,
      "status": "text",
      "answers": [
        {
          "id": 1,
          "answer": null
        }
      ],
      "fields": [
        {
          "id": 1,
          "field": {
            "id": 1,
            "name": "text",
            "description": "text",
            "type": "text",
            "rel_template": 1,
            "enum_values": [
              "text"
            ],
            "enum_many": true,
            "sources": [
              "text"
            ]
          },
          "status": "text",
          "value": null
        }
      ],
      "reports": [
        {
          "id": 1,
          "outline": {
            "id": 1,
            "outline": null,
            "perspective": "text"
          },
          "report": null
        }
      ]
    }
  ]
}

patch

Authorizations

knoxApiToken

Path parameters

idintegerRequired

A unique integer value identifying this profile.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerRead-onlyOptional

template_idintegerWrite-onlyOptional

specificationstring · max: 510Optional

templateall ofRead-onlyOptional

Responses

200Success

application/json

patch

/prod/v0/profiles/{id}/

HTTPcURLJavaScriptPython

PATCH /prod/v0/profiles/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "template_id": 1,
  "tags": [
    {
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": 1,
  "tags": [
    {
      "id": 1,
      "name": "text",
      "description": "text"
    }
  ],
  "specification": "text",
  "template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "snapshots": [
    {
      "id": 1,
      "status": "text",
      "answers": [
        {
          "id": 1,
          "answer": null
        }
      ],
      "fields": [
        {
          "id": 1,
          "field": {
            "id": 1,
            "name": "text",
            "description": "text",
            "type": "text",
            "rel_template": 1,
            "enum_values": [
              "text"
            ],
            "enum_many": true,
            "sources": [
              "text"
            ]
          },
          "status": "text",
          "value": null
        }
      ],
      "reports": [
        {
          "id": 1,
          "outline": {
            "id": 1,
            "outline": null,
            "perspective": "text"
          },
          "report": null
        }
      ]
    }
  ]
}

delete

Authorizations

knoxApiToken

Path parameters

idintegerRequired

A unique integer value identifying this profile.

Responses

204

No response body

No content

delete

/prod/v0/profiles/{id}/

HTTPcURLJavaScriptPython

DELETE /prod/v0/profiles/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

Profile Snapshot Operations

get

Authorizations

knoxApiToken

Responses

200Success

application/json

get

/prod/v0/snapshots/

HTTPcURLJavaScriptPython

GET /prod/v0/snapshots/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": 1,
    "status": "text",
    "answers": [
      {
        "id": 1,
        "answer": null
      }
    ],
    "fields": [
      {
        "id": 1,
        "field": {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        },
        "status": "text",
        "value": null
      }
    ],
    "reports": [
      {
        "id": 1,
        "outline": {
          "id": 1,
          "outline": null,
          "perspective": "text"
        },
        "report": null
      }
    ]
  }
]

get

Authorizations

knoxApiToken

Path parameters

idintegerRequired

A unique integer value identifying this snapshot.

Responses

200Success

application/json

get

/prod/v0/snapshots/{id}/

HTTPcURLJavaScriptPython

GET /prod/v0/snapshots/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": 1,
  "status": "text",
  "answers": [
    {
      "id": 1,
      "answer": null
    }
  ],
  "fields": [
    {
      "id": 1,
      "field": {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      },
      "status": "text",
      "value": null
    }
  ],
  "reports": [
    {
      "id": 1,
      "outline": {
        "id": 1,
        "outline": null,
        "perspective": "text"
      },
      "report": null
    }
  ]
}

get

Authorizations

knoxApiToken

Path parameters

profile_idstringRequiredPattern: ^\d+$

Responses

200Success

application/json

get

/prod/v0/profiles/{profile_id}/snapshots/

HTTPcURLJavaScriptPython

GET /prod/v0/profiles/{profile_id}/snapshots/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "id": 1,
    "answers": [
      {
        "id": 1,
        "answer": null
      }
    ],
    "fields": [
      {
        "id": 1,
        "field": {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        },
        "status": "text",
        "value": null
      }
    ],
    "reports": [
      {
        "id": 1,
        "outline": {
          "id": 1,
          "outline": null,
          "perspective": "text"
        },
        "report": null
      }
    ]
  }
]

post

Authorizations

knoxApiToken

Path parameters

profile_idstringRequiredPattern: ^\d+$

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerRead-onlyRequired

Responses

201Success

application/json

post

/prod/v0/profiles/{profile_id}/snapshots/

HTTPcURLJavaScriptPython

POST /prod/v0/profiles/{profile_id}/snapshots/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": 1,
  "answers": [
    {
      "id": 1,
      "answer": null
    }
  ],
  "fields": [
    {
      "id": 1,
      "field": {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      },
      "status": "text",
      "value": null
    }
  ],
  "reports": [
    {
      "id": 1,
      "outline": {
        "id": 1,
        "outline": null,
        "perspective": "text"
      },
      "report": null
    }
  ]
}

get

Authorizations

knoxApiToken

Path parameters

profile_idstringRequiredPattern: ^\d+$

snapshot_idstringRequired

Responses

200Success

application/json

get

/prod/v0/profiles/{profile_id}/snapshots/{snapshot_id}/

HTTPcURLJavaScriptPython

GET /prod/v0/profiles/{profile_id}/snapshots/{snapshot_id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": 1,
  "answers": [
    {
      "id": 1,
      "answer": null
    }
  ],
  "fields": [
    {
      "id": 1,
      "field": {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      },
      "status": "text",
      "value": null
    }
  ],
  "reports": [
    {
      "id": 1,
      "outline": {
        "id": 1,
        "outline": null,
        "perspective": "text"
      },
      "report": null
    }
  ]
}

get

Get the latest snapshot health for a profile

Authorizations

knoxApiToken

Path parameters

profile_idintegerRequired

Responses

200

No response body

No content

get

/prod/v0/health/profile/{profile_id}/latest/

HTTPcURLJavaScriptPython

GET /prod/v0/health/profile/{profile_id}/latest/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

No response body

No content

Add Created Field to Profile

post

Attach a created field to a profile

Authorizations

knoxApiToken

Path parameters

field_idstringRequiredPattern: ^\d+$

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

profile_idintegerWrite-onlyRequired

Responses

201

No response body

No content

post

/prod/v0/created-fields/{field_id}/profile/

HTTPcURLJavaScriptPython

POST /prod/v0/created-fields/{field_id}/profile/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "profile_id": 1
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201

No response body

No content