Export a framework - Openlayer

Python

from openlayer import Openlayer

client = Openlayer()

export = client.governance.frameworks.export(
    "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
    project_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
)
print(export.task_result_url)

import Openlayer from 'openlayer';

const client = new Openlayer();

const response = await client.governance.frameworks.export('5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b', {
  projectId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
});

console.log(response);

package main

import (
	"context"
	"fmt"

	"github.com/openlayer-ai/openlayer-go"
)

client := openlayer.NewClient()
export, err := client.Governance.Frameworks.Export(
	context.TODO(),
	"5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
	openlayer.GovernanceFrameworkExportParams{
		ProjectID: openlayer.F("3fa85f64-5717-4562-b3fc-2c963f66afa6"),
	},
)
if err != nil {
	panic(err.Error())
}
fmt.Printf("%+v\n", export.TaskResultURL)

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.governance.frameworks.FrameworkExportParams;
import com.openlayer.api.models.governance.frameworks.FrameworkExportResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

FrameworkExportParams params = FrameworkExportParams.builder()
    .frameworkId("5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b")
    .projectId("3fa85f64-5717-4562-b3fc-2c963f66afa6")
    .build();
FrameworkExportResponse export = client.governance().frameworks().export(params);

require "openlayer"

openlayer = Openlayer::Client.new(api_key: ENV["OPENLAYER_API_KEY"])

response = openlayer.governance.frameworks.export(
  "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  project_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
)

puts(response)

curl --request POST \
  --url https://api.openlayer.com/v1/frameworks/9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

{
  "taskResultUrl": "/v1/background-tasks/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "taskResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
  "code": 123,
  "error": "<string>"
}

Python

from openlayer import Openlayer

client = Openlayer()

export = client.governance.frameworks.export(
    "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
    project_id="3fa85f64-5717-4562-b3fc-2c963f66afa6",
)
print(export.task_result_url)

import Openlayer from 'openlayer';

const client = new Openlayer();

const response = await client.governance.frameworks.export('5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b', {
  projectId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
});

console.log(response);

package main

import (
	"context"
	"fmt"

	"github.com/openlayer-ai/openlayer-go"
)

client := openlayer.NewClient()
export, err := client.Governance.Frameworks.Export(
	context.TODO(),
	"5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
	openlayer.GovernanceFrameworkExportParams{
		ProjectID: openlayer.F("3fa85f64-5717-4562-b3fc-2c963f66afa6"),
	},
)
if err != nil {
	panic(err.Error())
}
fmt.Printf("%+v\n", export.TaskResultURL)

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.governance.frameworks.FrameworkExportParams;
import com.openlayer.api.models.governance.frameworks.FrameworkExportResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

FrameworkExportParams params = FrameworkExportParams.builder()
    .frameworkId("5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b")
    .projectId("3fa85f64-5717-4562-b3fc-2c963f66afa6")
    .build();
FrameworkExportResponse export = client.governance().frameworks().export(params);

require "openlayer"

openlayer = Openlayer::Client.new(api_key: ENV["OPENLAYER_API_KEY"])

response = openlayer.governance.frameworks.export(
  "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  project_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
)

puts(response)

curl --request POST \
  --url https://api.openlayer.com/v1/frameworks/9f1b3c2d-4e5a-4f60-8a71-2b3c4d5e6f70/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}'

{
  "taskResultUrl": "/v1/background-tasks/3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "taskResultId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
  "code": 123,
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

frameworkId

string<uuid>

required

The framework id.

Body

application/json

projectId

string<uuid> | null

Scope the export to this project. It must belong to the framework. Omit it for the workspace-wide view across every project in the framework, including workspace-scoped rules.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Export queued. Poll taskResultUrl for the archive. If an identical export is still queued, that task is returned instead of a new one. The archive holds every evidence file uploaded against the framework's evidence rules, a markdown report of the framework's progress and rule statuses (by documentation section when the framework has documents), and CSV manifests of rules and evidence with SHA-256 checksums.

taskResultUrl

string

required

The path to poll for this export's status and result. Already /v1-prefixed, so it is relative to the API host rather than to the /v1 base url -- or just pass taskResultId to GET /background-tasks/{taskId}.

Example:

"/v1/background-tasks/3fa85f64-5717-4562-b3fc-2c963f66afa6"

taskResultId

string<uuid>

required

The background task id, for GET /background-tasks/{taskId}.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"