Create Organization's associated Security Framework Document

cURL

curl --request POST \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid} \
  --header 'Content-Type: */*' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '"<string>"'

import requests

url = "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}"

payload = "<string>"
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "*/*"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': '*/*'},
  body: JSON.stringify('<string>')
};

fetch('https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode('<string>'),
  CURLOPT_HTTPHEADER => [
    "Content-Type: */*",
    "X-Aegister-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}"

	payload := strings.NewReader("\"<string>\"")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Aegister-Token", "<api-key>")
	req.Header.Add("Content-Type", "*/*")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "*/*")
  .body("\"<string>\"")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = '*/*'
request.body = "\"<string>\""

response = http.request(request)
puts response.read_body

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "file_name": "<string>",
    "file_path": "<string>"
  }
}

{
  "error": 0,
  "messages": "<array>"
}

{
  "error": 0,
  "messages": "<array>"
}

POST

api

organizations

{organizationid}

security-frameworks

{frameworkid}

documents

{controlid}

cURL

curl --request POST \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid} \
  --header 'Content-Type: */*' \
  --header 'X-Aegister-Token: <api-key>' \
  --data '"<string>"'

import requests

url = "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}"

payload = "<string>"
headers = {
    "X-Aegister-Token": "<api-key>",
    "Content-Type": "*/*"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': '*/*'},
  body: JSON.stringify('<string>')
};

fetch('https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode('<string>'),
  CURLOPT_HTTPHEADER => [
    "Content-Type: */*",
    "X-Aegister-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}"

	payload := strings.NewReader("\"<string>\"")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Aegister-Token", "<api-key>")
	req.Header.Add("Content-Type", "*/*")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}")
  .header("X-Aegister-Token", "<api-key>")
  .header("Content-Type", "*/*")
  .body("\"<string>\"")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}/documents/{controlid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = '*/*'
request.body = "\"<string>\""

response = http.request(request)
puts response.read_body

{
  "error": 0,
  "messages": "<array>",
  "data": {
    "file_name": "<string>",
    "file_path": "<string>"
  }
}

{
  "error": 0,
  "messages": "<array>"
}

{
  "error": 0,
  "messages": "<array>"
}

Authorizations

X-Aegister-Token

string

header

required

Headers

Content-Disposition

string

default:attachment; filename=sample.pdf

Specify 'attachment' as content disposition and file name.

Path Parameters

controlid

string

required

frameworkid

integer

required

organizationid

integer

required

Body

*/*

The body is of type file.

Response

error

integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

Example:

0

messages

array

If error is 1, contains zero or more details on the error.

Example:

[]

data

object

Show child attributes

API Documentation

Endpoints

Create Organization's associated Security Framework Document

Authorizations

Headers

Path Parameters

Body

Response