Create an Asset Type
curl --request POST \
--url https://api.us.lexful.app/v1/asset_types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Account-ID: <x-account-id>' \
--data '
{
"name": "secure_project",
"display_name": "Secure Projects",
"description": "Project management with secure credentials and file attachments",
"is_system": false,
"properties": [
{
"name": "project_name",
"type": "string",
"display_name": "Project Name",
"description": "Name of the project",
"required": true
},
{
"name": "budget",
"type": "number",
"display_name": "Budget",
"description": "Project budget in dollars",
"required": false
},
{
"name": "team_size",
"type": "integer",
"display_name": "Team Size",
"description": "Number of team members",
"required": false
},
{
"name": "is_active",
"type": "boolean",
"display_name": "Active",
"description": "Whether project is currently active",
"required": true
},
{
"name": "milestones",
"type": "array",
"display_name": "Milestones",
"description": "Project milestones and deliverables",
"required": false,
"array": {
"type": "object",
"properties": [
{
"name": "title",
"type": "string",
"display_name": "Milestone Title",
"required": true
},
{
"name": "completion_percentage",
"type": "integer",
"display_name": "Completion %",
"required": true
}
]
}
},
{
"name": "api_key",
"type": "secret",
"display_name": "API Key",
"description": "Encrypted API key for external integration",
"required": false
},
{
"name": "mfa_token",
"type": "totp",
"display_name": "MFA Token",
"description": "Time-based one-time password for authentication",
"required": false
},
{
"name": "project_plan",
"type": "file",
"display_name": "Project Plan",
"description": "Project planning document",
"required": false,
"file_rules": {
"max_size": 10485760,
"allowed_extensions": [
".pdf",
".docx",
".xlsx"
],
"allowed_mime_types": [
"application/pdf",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
]
}
},
{
"name": "start_date",
"type": "date",
"display_name": "Start Date",
"description": "Project start date",
"required": true
},
{
"name": "last_activity",
"type": "datetime",
"display_name": "Last Activity",
"description": "Last activity timestamp",
"required": false
},
{
"name": "description",
"type": "richtext",
"display_name": "Description",
"description": "Project description with formatting",
"required": false
},
{
"name": "detailed_specification",
"type": "richtext_large",
"display_name": "Detailed Specification",
"description": "Complete project specification document",
"required": false
}
],
"references": [
{
"name": "project_lead",
"display_name": "Project Lead",
"description": "Primary contact responsible for project",
"required": true,
"multiple": false,
"target_asset_types": [
"system.contact"
]
},
{
"name": "team_members",
"display_name": "Team Members",
"description": "Project team members",
"required": false,
"multiple": true,
"target_asset_types": [
"system.contact"
]
}
]
}
'import requests
url = "https://api.us.lexful.app/v1/asset_types"
payload = {
"name": "secure_project",
"display_name": "Secure Projects",
"description": "Project management with secure credentials and file attachments",
"is_system": False,
"properties": [
{
"name": "project_name",
"type": "string",
"display_name": "Project Name",
"description": "Name of the project",
"required": True
},
{
"name": "budget",
"type": "number",
"display_name": "Budget",
"description": "Project budget in dollars",
"required": False
},
{
"name": "team_size",
"type": "integer",
"display_name": "Team Size",
"description": "Number of team members",
"required": False
},
{
"name": "is_active",
"type": "boolean",
"display_name": "Active",
"description": "Whether project is currently active",
"required": True
},
{
"name": "milestones",
"type": "array",
"display_name": "Milestones",
"description": "Project milestones and deliverables",
"required": False,
"array": {
"type": "object",
"properties": [
{
"name": "title",
"type": "string",
"display_name": "Milestone Title",
"required": True
},
{
"name": "completion_percentage",
"type": "integer",
"display_name": "Completion %",
"required": True
}
]
}
},
{
"name": "api_key",
"type": "secret",
"display_name": "API Key",
"description": "Encrypted API key for external integration",
"required": False
},
{
"name": "mfa_token",
"type": "totp",
"display_name": "MFA Token",
"description": "Time-based one-time password for authentication",
"required": False
},
{
"name": "project_plan",
"type": "file",
"display_name": "Project Plan",
"description": "Project planning document",
"required": False,
"file_rules": {
"max_size": 10485760,
"allowed_extensions": [".pdf", ".docx", ".xlsx"],
"allowed_mime_types": ["application/pdf", "application/vnd.openxmlformats-officedocument.wordprocessingml.document"]
}
},
{
"name": "start_date",
"type": "date",
"display_name": "Start Date",
"description": "Project start date",
"required": True
},
{
"name": "last_activity",
"type": "datetime",
"display_name": "Last Activity",
"description": "Last activity timestamp",
"required": False
},
{
"name": "description",
"type": "richtext",
"display_name": "Description",
"description": "Project description with formatting",
"required": False
},
{
"name": "detailed_specification",
"type": "richtext_large",
"display_name": "Detailed Specification",
"description": "Complete project specification document",
"required": False
}
],
"references": [
{
"name": "project_lead",
"display_name": "Project Lead",
"description": "Primary contact responsible for project",
"required": True,
"multiple": False,
"target_asset_types": ["system.contact"]
},
{
"name": "team_members",
"display_name": "Team Members",
"description": "Project team members",
"required": False,
"multiple": True,
"target_asset_types": ["system.contact"]
}
]
}
headers = {
"X-Account-ID": "<x-account-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Account-ID': '<x-account-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'secure_project',
display_name: 'Secure Projects',
description: 'Project management with secure credentials and file attachments',
is_system: false,
properties: [
{
name: 'project_name',
type: 'string',
display_name: 'Project Name',
description: 'Name of the project',
required: true
},
{
name: 'budget',
type: 'number',
display_name: 'Budget',
description: 'Project budget in dollars',
required: false
},
{
name: 'team_size',
type: 'integer',
display_name: 'Team Size',
description: 'Number of team members',
required: false
},
{
name: 'is_active',
type: 'boolean',
display_name: 'Active',
description: 'Whether project is currently active',
required: true
},
{
name: 'milestones',
type: 'array',
display_name: 'Milestones',
description: 'Project milestones and deliverables',
required: false,
array: {
type: 'object',
properties: [
{name: 'title', type: 'string', display_name: 'Milestone Title', required: true},
{
name: 'completion_percentage',
type: 'integer',
display_name: 'Completion %',
required: true
}
]
}
},
{
name: 'api_key',
type: 'secret',
display_name: 'API Key',
description: 'Encrypted API key for external integration',
required: false
},
{
name: 'mfa_token',
type: 'totp',
display_name: 'MFA Token',
description: 'Time-based one-time password for authentication',
required: false
},
{
name: 'project_plan',
type: 'file',
display_name: 'Project Plan',
description: 'Project planning document',
required: false,
file_rules: {
max_size: 10485760,
allowed_extensions: ['.pdf', '.docx', '.xlsx'],
allowed_mime_types: [
'application/pdf',
'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
]
}
},
{
name: 'start_date',
type: 'date',
display_name: 'Start Date',
description: 'Project start date',
required: true
},
{
name: 'last_activity',
type: 'datetime',
display_name: 'Last Activity',
description: 'Last activity timestamp',
required: false
},
{
name: 'description',
type: 'richtext',
display_name: 'Description',
description: 'Project description with formatting',
required: false
},
{
name: 'detailed_specification',
type: 'richtext_large',
display_name: 'Detailed Specification',
description: 'Complete project specification document',
required: false
}
],
references: [
{
name: 'project_lead',
display_name: 'Project Lead',
description: 'Primary contact responsible for project',
required: true,
multiple: false,
target_asset_types: ['system.contact']
},
{
name: 'team_members',
display_name: 'Team Members',
description: 'Project team members',
required: false,
multiple: true,
target_asset_types: ['system.contact']
}
]
})
};
fetch('https://api.us.lexful.app/v1/asset_types', 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://api.us.lexful.app/v1/asset_types",
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([
'name' => 'secure_project',
'display_name' => 'Secure Projects',
'description' => 'Project management with secure credentials and file attachments',
'is_system' => false,
'properties' => [
[
'name' => 'project_name',
'type' => 'string',
'display_name' => 'Project Name',
'description' => 'Name of the project',
'required' => true
],
[
'name' => 'budget',
'type' => 'number',
'display_name' => 'Budget',
'description' => 'Project budget in dollars',
'required' => false
],
[
'name' => 'team_size',
'type' => 'integer',
'display_name' => 'Team Size',
'description' => 'Number of team members',
'required' => false
],
[
'name' => 'is_active',
'type' => 'boolean',
'display_name' => 'Active',
'description' => 'Whether project is currently active',
'required' => true
],
[
'name' => 'milestones',
'type' => 'array',
'display_name' => 'Milestones',
'description' => 'Project milestones and deliverables',
'required' => false,
'array' => [
'type' => 'object',
'properties' => [
[
'name' => 'title',
'type' => 'string',
'display_name' => 'Milestone Title',
'required' => true
],
[
'name' => 'completion_percentage',
'type' => 'integer',
'display_name' => 'Completion %',
'required' => true
]
]
]
],
[
'name' => 'api_key',
'type' => 'secret',
'display_name' => 'API Key',
'description' => 'Encrypted API key for external integration',
'required' => false
],
[
'name' => 'mfa_token',
'type' => 'totp',
'display_name' => 'MFA Token',
'description' => 'Time-based one-time password for authentication',
'required' => false
],
[
'name' => 'project_plan',
'type' => 'file',
'display_name' => 'Project Plan',
'description' => 'Project planning document',
'required' => false,
'file_rules' => [
'max_size' => 10485760,
'allowed_extensions' => [
'.pdf',
'.docx',
'.xlsx'
],
'allowed_mime_types' => [
'application/pdf',
'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
]
]
],
[
'name' => 'start_date',
'type' => 'date',
'display_name' => 'Start Date',
'description' => 'Project start date',
'required' => true
],
[
'name' => 'last_activity',
'type' => 'datetime',
'display_name' => 'Last Activity',
'description' => 'Last activity timestamp',
'required' => false
],
[
'name' => 'description',
'type' => 'richtext',
'display_name' => 'Description',
'description' => 'Project description with formatting',
'required' => false
],
[
'name' => 'detailed_specification',
'type' => 'richtext_large',
'display_name' => 'Detailed Specification',
'description' => 'Complete project specification document',
'required' => false
]
],
'references' => [
[
'name' => 'project_lead',
'display_name' => 'Project Lead',
'description' => 'Primary contact responsible for project',
'required' => true,
'multiple' => false,
'target_asset_types' => [
'system.contact'
]
],
[
'name' => 'team_members',
'display_name' => 'Team Members',
'description' => 'Project team members',
'required' => false,
'multiple' => true,
'target_asset_types' => [
'system.contact'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <x-account-id>"
],
]);
$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://api.us.lexful.app/v1/asset_types"
payload := strings.NewReader("{\n \"name\": \"secure_project\",\n \"display_name\": \"Secure Projects\",\n \"description\": \"Project management with secure credentials and file attachments\",\n \"is_system\": false,\n \"properties\": [\n {\n \"name\": \"project_name\",\n \"type\": \"string\",\n \"display_name\": \"Project Name\",\n \"description\": \"Name of the project\",\n \"required\": true\n },\n {\n \"name\": \"budget\",\n \"type\": \"number\",\n \"display_name\": \"Budget\",\n \"description\": \"Project budget in dollars\",\n \"required\": false\n },\n {\n \"name\": \"team_size\",\n \"type\": \"integer\",\n \"display_name\": \"Team Size\",\n \"description\": \"Number of team members\",\n \"required\": false\n },\n {\n \"name\": \"is_active\",\n \"type\": \"boolean\",\n \"display_name\": \"Active\",\n \"description\": \"Whether project is currently active\",\n \"required\": true\n },\n {\n \"name\": \"milestones\",\n \"type\": \"array\",\n \"display_name\": \"Milestones\",\n \"description\": \"Project milestones and deliverables\",\n \"required\": false,\n \"array\": {\n \"type\": \"object\",\n \"properties\": [\n {\n \"name\": \"title\",\n \"type\": \"string\",\n \"display_name\": \"Milestone Title\",\n \"required\": true\n },\n {\n \"name\": \"completion_percentage\",\n \"type\": \"integer\",\n \"display_name\": \"Completion %\",\n \"required\": true\n }\n ]\n }\n },\n {\n \"name\": \"api_key\",\n \"type\": \"secret\",\n \"display_name\": \"API Key\",\n \"description\": \"Encrypted API key for external integration\",\n \"required\": false\n },\n {\n \"name\": \"mfa_token\",\n \"type\": \"totp\",\n \"display_name\": \"MFA Token\",\n \"description\": \"Time-based one-time password for authentication\",\n \"required\": false\n },\n {\n \"name\": \"project_plan\",\n \"type\": \"file\",\n \"display_name\": \"Project Plan\",\n \"description\": \"Project planning document\",\n \"required\": false,\n \"file_rules\": {\n \"max_size\": 10485760,\n \"allowed_extensions\": [\n \".pdf\",\n \".docx\",\n \".xlsx\"\n ],\n \"allowed_mime_types\": [\n \"application/pdf\",\n \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n ]\n }\n },\n {\n \"name\": \"start_date\",\n \"type\": \"date\",\n \"display_name\": \"Start Date\",\n \"description\": \"Project start date\",\n \"required\": true\n },\n {\n \"name\": \"last_activity\",\n \"type\": \"datetime\",\n \"display_name\": \"Last Activity\",\n \"description\": \"Last activity timestamp\",\n \"required\": false\n },\n {\n \"name\": \"description\",\n \"type\": \"richtext\",\n \"display_name\": \"Description\",\n \"description\": \"Project description with formatting\",\n \"required\": false\n },\n {\n \"name\": \"detailed_specification\",\n \"type\": \"richtext_large\",\n \"display_name\": \"Detailed Specification\",\n \"description\": \"Complete project specification document\",\n \"required\": false\n }\n ],\n \"references\": [\n {\n \"name\": \"project_lead\",\n \"display_name\": \"Project Lead\",\n \"description\": \"Primary contact responsible for project\",\n \"required\": true,\n \"multiple\": false,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n },\n {\n \"name\": \"team_members\",\n \"display_name\": \"Team Members\",\n \"description\": \"Project team members\",\n \"required\": false,\n \"multiple\": true,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Account-ID", "<x-account-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.lexful.app/v1/asset_types")
.header("X-Account-ID", "<x-account-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"secure_project\",\n \"display_name\": \"Secure Projects\",\n \"description\": \"Project management with secure credentials and file attachments\",\n \"is_system\": false,\n \"properties\": [\n {\n \"name\": \"project_name\",\n \"type\": \"string\",\n \"display_name\": \"Project Name\",\n \"description\": \"Name of the project\",\n \"required\": true\n },\n {\n \"name\": \"budget\",\n \"type\": \"number\",\n \"display_name\": \"Budget\",\n \"description\": \"Project budget in dollars\",\n \"required\": false\n },\n {\n \"name\": \"team_size\",\n \"type\": \"integer\",\n \"display_name\": \"Team Size\",\n \"description\": \"Number of team members\",\n \"required\": false\n },\n {\n \"name\": \"is_active\",\n \"type\": \"boolean\",\n \"display_name\": \"Active\",\n \"description\": \"Whether project is currently active\",\n \"required\": true\n },\n {\n \"name\": \"milestones\",\n \"type\": \"array\",\n \"display_name\": \"Milestones\",\n \"description\": \"Project milestones and deliverables\",\n \"required\": false,\n \"array\": {\n \"type\": \"object\",\n \"properties\": [\n {\n \"name\": \"title\",\n \"type\": \"string\",\n \"display_name\": \"Milestone Title\",\n \"required\": true\n },\n {\n \"name\": \"completion_percentage\",\n \"type\": \"integer\",\n \"display_name\": \"Completion %\",\n \"required\": true\n }\n ]\n }\n },\n {\n \"name\": \"api_key\",\n \"type\": \"secret\",\n \"display_name\": \"API Key\",\n \"description\": \"Encrypted API key for external integration\",\n \"required\": false\n },\n {\n \"name\": \"mfa_token\",\n \"type\": \"totp\",\n \"display_name\": \"MFA Token\",\n \"description\": \"Time-based one-time password for authentication\",\n \"required\": false\n },\n {\n \"name\": \"project_plan\",\n \"type\": \"file\",\n \"display_name\": \"Project Plan\",\n \"description\": \"Project planning document\",\n \"required\": false,\n \"file_rules\": {\n \"max_size\": 10485760,\n \"allowed_extensions\": [\n \".pdf\",\n \".docx\",\n \".xlsx\"\n ],\n \"allowed_mime_types\": [\n \"application/pdf\",\n \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n ]\n }\n },\n {\n \"name\": \"start_date\",\n \"type\": \"date\",\n \"display_name\": \"Start Date\",\n \"description\": \"Project start date\",\n \"required\": true\n },\n {\n \"name\": \"last_activity\",\n \"type\": \"datetime\",\n \"display_name\": \"Last Activity\",\n \"description\": \"Last activity timestamp\",\n \"required\": false\n },\n {\n \"name\": \"description\",\n \"type\": \"richtext\",\n \"display_name\": \"Description\",\n \"description\": \"Project description with formatting\",\n \"required\": false\n },\n {\n \"name\": \"detailed_specification\",\n \"type\": \"richtext_large\",\n \"display_name\": \"Detailed Specification\",\n \"description\": \"Complete project specification document\",\n \"required\": false\n }\n ],\n \"references\": [\n {\n \"name\": \"project_lead\",\n \"display_name\": \"Project Lead\",\n \"description\": \"Primary contact responsible for project\",\n \"required\": true,\n \"multiple\": false,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n },\n {\n \"name\": \"team_members\",\n \"display_name\": \"Team Members\",\n \"description\": \"Project team members\",\n \"required\": false,\n \"multiple\": true,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.lexful.app/v1/asset_types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Account-ID"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"secure_project\",\n \"display_name\": \"Secure Projects\",\n \"description\": \"Project management with secure credentials and file attachments\",\n \"is_system\": false,\n \"properties\": [\n {\n \"name\": \"project_name\",\n \"type\": \"string\",\n \"display_name\": \"Project Name\",\n \"description\": \"Name of the project\",\n \"required\": true\n },\n {\n \"name\": \"budget\",\n \"type\": \"number\",\n \"display_name\": \"Budget\",\n \"description\": \"Project budget in dollars\",\n \"required\": false\n },\n {\n \"name\": \"team_size\",\n \"type\": \"integer\",\n \"display_name\": \"Team Size\",\n \"description\": \"Number of team members\",\n \"required\": false\n },\n {\n \"name\": \"is_active\",\n \"type\": \"boolean\",\n \"display_name\": \"Active\",\n \"description\": \"Whether project is currently active\",\n \"required\": true\n },\n {\n \"name\": \"milestones\",\n \"type\": \"array\",\n \"display_name\": \"Milestones\",\n \"description\": \"Project milestones and deliverables\",\n \"required\": false,\n \"array\": {\n \"type\": \"object\",\n \"properties\": [\n {\n \"name\": \"title\",\n \"type\": \"string\",\n \"display_name\": \"Milestone Title\",\n \"required\": true\n },\n {\n \"name\": \"completion_percentage\",\n \"type\": \"integer\",\n \"display_name\": \"Completion %\",\n \"required\": true\n }\n ]\n }\n },\n {\n \"name\": \"api_key\",\n \"type\": \"secret\",\n \"display_name\": \"API Key\",\n \"description\": \"Encrypted API key for external integration\",\n \"required\": false\n },\n {\n \"name\": \"mfa_token\",\n \"type\": \"totp\",\n \"display_name\": \"MFA Token\",\n \"description\": \"Time-based one-time password for authentication\",\n \"required\": false\n },\n {\n \"name\": \"project_plan\",\n \"type\": \"file\",\n \"display_name\": \"Project Plan\",\n \"description\": \"Project planning document\",\n \"required\": false,\n \"file_rules\": {\n \"max_size\": 10485760,\n \"allowed_extensions\": [\n \".pdf\",\n \".docx\",\n \".xlsx\"\n ],\n \"allowed_mime_types\": [\n \"application/pdf\",\n \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n ]\n }\n },\n {\n \"name\": \"start_date\",\n \"type\": \"date\",\n \"display_name\": \"Start Date\",\n \"description\": \"Project start date\",\n \"required\": true\n },\n {\n \"name\": \"last_activity\",\n \"type\": \"datetime\",\n \"display_name\": \"Last Activity\",\n \"description\": \"Last activity timestamp\",\n \"required\": false\n },\n {\n \"name\": \"description\",\n \"type\": \"richtext\",\n \"display_name\": \"Description\",\n \"description\": \"Project description with formatting\",\n \"required\": false\n },\n {\n \"name\": \"detailed_specification\",\n \"type\": \"richtext_large\",\n \"display_name\": \"Detailed Specification\",\n \"description\": \"Complete project specification document\",\n \"required\": false\n }\n ],\n \"references\": [\n {\n \"name\": \"project_lead\",\n \"display_name\": \"Project Lead\",\n \"description\": \"Primary contact responsible for project\",\n \"required\": true,\n \"multiple\": false,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n },\n {\n \"name\": \"team_members\",\n \"display_name\": \"Team Members\",\n \"description\": \"Project team members\",\n \"required\": false,\n \"multiple\": true,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
"account_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
"name": "system.contact",
"display_name": "Contacts",
"description": "Contacts are people and identities associated with an organization",
"is_system": true,
"properties": [
{
"name": "first_name",
"type": "string",
"display_name": "First Name",
"required": false
},
{
"name": "last_name",
"type": "string",
"display_name": "Last Name",
"required": false
},
{
"name": "title",
"type": "string",
"display_name": "Title",
"required": false
},
{
"name": "important",
"type": "boolean",
"display_name": "Important",
"required": true
},
{
"name": "contact_type",
"type": "string",
"display_name": "Contact Type",
"required": false,
"enum": [
"Approver",
"Champion",
"Decision Maker",
"End User",
"Evaluator",
"Influencer",
"Owner",
"Other"
]
},
{
"name": "contact_methods",
"type": "array",
"display_name": "Contact Methods",
"required": false,
"array": {
"type": "object",
"properties": [
{
"name": "type",
"type": "string",
"display_name": "Contact Method Type",
"required": true,
"enum": [
"Phone",
"Fax",
"Mobile",
"Email",
"Website",
"Twitter",
"LinkedIn",
"Other"
]
},
{
"name": "value",
"type": "string",
"display_name": "Contact Method Value",
"required": true
}
]
}
},
{
"name": "preferred_contact_method",
"type": "string",
"display_name": "Preferred Contact Method",
"required": false,
"enum": [
"Phone",
"Fax",
"Mobile",
"Email",
"Website",
"Twitter",
"LinkedIn",
"Other"
]
},
{
"name": "notes",
"type": "richtext",
"display_name": "Notes",
"required": false
}
],
"references": [
{
"name": "location",
"display_name": "Location",
"required": false,
"multiple": false,
"target_asset_types": [
"system.location"
]
}
],
"version": 1,
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z",
"created_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
"updated_by": "019983a9-c4c0-73af-aec9-463feeadc2e7"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}Asset Types
Create an Asset Type
Create a new asset type
POST
/
v1
/
asset_types
Create an Asset Type
curl --request POST \
--url https://api.us.lexful.app/v1/asset_types \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Account-ID: <x-account-id>' \
--data '
{
"name": "secure_project",
"display_name": "Secure Projects",
"description": "Project management with secure credentials and file attachments",
"is_system": false,
"properties": [
{
"name": "project_name",
"type": "string",
"display_name": "Project Name",
"description": "Name of the project",
"required": true
},
{
"name": "budget",
"type": "number",
"display_name": "Budget",
"description": "Project budget in dollars",
"required": false
},
{
"name": "team_size",
"type": "integer",
"display_name": "Team Size",
"description": "Number of team members",
"required": false
},
{
"name": "is_active",
"type": "boolean",
"display_name": "Active",
"description": "Whether project is currently active",
"required": true
},
{
"name": "milestones",
"type": "array",
"display_name": "Milestones",
"description": "Project milestones and deliverables",
"required": false,
"array": {
"type": "object",
"properties": [
{
"name": "title",
"type": "string",
"display_name": "Milestone Title",
"required": true
},
{
"name": "completion_percentage",
"type": "integer",
"display_name": "Completion %",
"required": true
}
]
}
},
{
"name": "api_key",
"type": "secret",
"display_name": "API Key",
"description": "Encrypted API key for external integration",
"required": false
},
{
"name": "mfa_token",
"type": "totp",
"display_name": "MFA Token",
"description": "Time-based one-time password for authentication",
"required": false
},
{
"name": "project_plan",
"type": "file",
"display_name": "Project Plan",
"description": "Project planning document",
"required": false,
"file_rules": {
"max_size": 10485760,
"allowed_extensions": [
".pdf",
".docx",
".xlsx"
],
"allowed_mime_types": [
"application/pdf",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
]
}
},
{
"name": "start_date",
"type": "date",
"display_name": "Start Date",
"description": "Project start date",
"required": true
},
{
"name": "last_activity",
"type": "datetime",
"display_name": "Last Activity",
"description": "Last activity timestamp",
"required": false
},
{
"name": "description",
"type": "richtext",
"display_name": "Description",
"description": "Project description with formatting",
"required": false
},
{
"name": "detailed_specification",
"type": "richtext_large",
"display_name": "Detailed Specification",
"description": "Complete project specification document",
"required": false
}
],
"references": [
{
"name": "project_lead",
"display_name": "Project Lead",
"description": "Primary contact responsible for project",
"required": true,
"multiple": false,
"target_asset_types": [
"system.contact"
]
},
{
"name": "team_members",
"display_name": "Team Members",
"description": "Project team members",
"required": false,
"multiple": true,
"target_asset_types": [
"system.contact"
]
}
]
}
'import requests
url = "https://api.us.lexful.app/v1/asset_types"
payload = {
"name": "secure_project",
"display_name": "Secure Projects",
"description": "Project management with secure credentials and file attachments",
"is_system": False,
"properties": [
{
"name": "project_name",
"type": "string",
"display_name": "Project Name",
"description": "Name of the project",
"required": True
},
{
"name": "budget",
"type": "number",
"display_name": "Budget",
"description": "Project budget in dollars",
"required": False
},
{
"name": "team_size",
"type": "integer",
"display_name": "Team Size",
"description": "Number of team members",
"required": False
},
{
"name": "is_active",
"type": "boolean",
"display_name": "Active",
"description": "Whether project is currently active",
"required": True
},
{
"name": "milestones",
"type": "array",
"display_name": "Milestones",
"description": "Project milestones and deliverables",
"required": False,
"array": {
"type": "object",
"properties": [
{
"name": "title",
"type": "string",
"display_name": "Milestone Title",
"required": True
},
{
"name": "completion_percentage",
"type": "integer",
"display_name": "Completion %",
"required": True
}
]
}
},
{
"name": "api_key",
"type": "secret",
"display_name": "API Key",
"description": "Encrypted API key for external integration",
"required": False
},
{
"name": "mfa_token",
"type": "totp",
"display_name": "MFA Token",
"description": "Time-based one-time password for authentication",
"required": False
},
{
"name": "project_plan",
"type": "file",
"display_name": "Project Plan",
"description": "Project planning document",
"required": False,
"file_rules": {
"max_size": 10485760,
"allowed_extensions": [".pdf", ".docx", ".xlsx"],
"allowed_mime_types": ["application/pdf", "application/vnd.openxmlformats-officedocument.wordprocessingml.document"]
}
},
{
"name": "start_date",
"type": "date",
"display_name": "Start Date",
"description": "Project start date",
"required": True
},
{
"name": "last_activity",
"type": "datetime",
"display_name": "Last Activity",
"description": "Last activity timestamp",
"required": False
},
{
"name": "description",
"type": "richtext",
"display_name": "Description",
"description": "Project description with formatting",
"required": False
},
{
"name": "detailed_specification",
"type": "richtext_large",
"display_name": "Detailed Specification",
"description": "Complete project specification document",
"required": False
}
],
"references": [
{
"name": "project_lead",
"display_name": "Project Lead",
"description": "Primary contact responsible for project",
"required": True,
"multiple": False,
"target_asset_types": ["system.contact"]
},
{
"name": "team_members",
"display_name": "Team Members",
"description": "Project team members",
"required": False,
"multiple": True,
"target_asset_types": ["system.contact"]
}
]
}
headers = {
"X-Account-ID": "<x-account-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Account-ID': '<x-account-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'secure_project',
display_name: 'Secure Projects',
description: 'Project management with secure credentials and file attachments',
is_system: false,
properties: [
{
name: 'project_name',
type: 'string',
display_name: 'Project Name',
description: 'Name of the project',
required: true
},
{
name: 'budget',
type: 'number',
display_name: 'Budget',
description: 'Project budget in dollars',
required: false
},
{
name: 'team_size',
type: 'integer',
display_name: 'Team Size',
description: 'Number of team members',
required: false
},
{
name: 'is_active',
type: 'boolean',
display_name: 'Active',
description: 'Whether project is currently active',
required: true
},
{
name: 'milestones',
type: 'array',
display_name: 'Milestones',
description: 'Project milestones and deliverables',
required: false,
array: {
type: 'object',
properties: [
{name: 'title', type: 'string', display_name: 'Milestone Title', required: true},
{
name: 'completion_percentage',
type: 'integer',
display_name: 'Completion %',
required: true
}
]
}
},
{
name: 'api_key',
type: 'secret',
display_name: 'API Key',
description: 'Encrypted API key for external integration',
required: false
},
{
name: 'mfa_token',
type: 'totp',
display_name: 'MFA Token',
description: 'Time-based one-time password for authentication',
required: false
},
{
name: 'project_plan',
type: 'file',
display_name: 'Project Plan',
description: 'Project planning document',
required: false,
file_rules: {
max_size: 10485760,
allowed_extensions: ['.pdf', '.docx', '.xlsx'],
allowed_mime_types: [
'application/pdf',
'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
]
}
},
{
name: 'start_date',
type: 'date',
display_name: 'Start Date',
description: 'Project start date',
required: true
},
{
name: 'last_activity',
type: 'datetime',
display_name: 'Last Activity',
description: 'Last activity timestamp',
required: false
},
{
name: 'description',
type: 'richtext',
display_name: 'Description',
description: 'Project description with formatting',
required: false
},
{
name: 'detailed_specification',
type: 'richtext_large',
display_name: 'Detailed Specification',
description: 'Complete project specification document',
required: false
}
],
references: [
{
name: 'project_lead',
display_name: 'Project Lead',
description: 'Primary contact responsible for project',
required: true,
multiple: false,
target_asset_types: ['system.contact']
},
{
name: 'team_members',
display_name: 'Team Members',
description: 'Project team members',
required: false,
multiple: true,
target_asset_types: ['system.contact']
}
]
})
};
fetch('https://api.us.lexful.app/v1/asset_types', 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://api.us.lexful.app/v1/asset_types",
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([
'name' => 'secure_project',
'display_name' => 'Secure Projects',
'description' => 'Project management with secure credentials and file attachments',
'is_system' => false,
'properties' => [
[
'name' => 'project_name',
'type' => 'string',
'display_name' => 'Project Name',
'description' => 'Name of the project',
'required' => true
],
[
'name' => 'budget',
'type' => 'number',
'display_name' => 'Budget',
'description' => 'Project budget in dollars',
'required' => false
],
[
'name' => 'team_size',
'type' => 'integer',
'display_name' => 'Team Size',
'description' => 'Number of team members',
'required' => false
],
[
'name' => 'is_active',
'type' => 'boolean',
'display_name' => 'Active',
'description' => 'Whether project is currently active',
'required' => true
],
[
'name' => 'milestones',
'type' => 'array',
'display_name' => 'Milestones',
'description' => 'Project milestones and deliverables',
'required' => false,
'array' => [
'type' => 'object',
'properties' => [
[
'name' => 'title',
'type' => 'string',
'display_name' => 'Milestone Title',
'required' => true
],
[
'name' => 'completion_percentage',
'type' => 'integer',
'display_name' => 'Completion %',
'required' => true
]
]
]
],
[
'name' => 'api_key',
'type' => 'secret',
'display_name' => 'API Key',
'description' => 'Encrypted API key for external integration',
'required' => false
],
[
'name' => 'mfa_token',
'type' => 'totp',
'display_name' => 'MFA Token',
'description' => 'Time-based one-time password for authentication',
'required' => false
],
[
'name' => 'project_plan',
'type' => 'file',
'display_name' => 'Project Plan',
'description' => 'Project planning document',
'required' => false,
'file_rules' => [
'max_size' => 10485760,
'allowed_extensions' => [
'.pdf',
'.docx',
'.xlsx'
],
'allowed_mime_types' => [
'application/pdf',
'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
]
]
],
[
'name' => 'start_date',
'type' => 'date',
'display_name' => 'Start Date',
'description' => 'Project start date',
'required' => true
],
[
'name' => 'last_activity',
'type' => 'datetime',
'display_name' => 'Last Activity',
'description' => 'Last activity timestamp',
'required' => false
],
[
'name' => 'description',
'type' => 'richtext',
'display_name' => 'Description',
'description' => 'Project description with formatting',
'required' => false
],
[
'name' => 'detailed_specification',
'type' => 'richtext_large',
'display_name' => 'Detailed Specification',
'description' => 'Complete project specification document',
'required' => false
]
],
'references' => [
[
'name' => 'project_lead',
'display_name' => 'Project Lead',
'description' => 'Primary contact responsible for project',
'required' => true,
'multiple' => false,
'target_asset_types' => [
'system.contact'
]
],
[
'name' => 'team_members',
'display_name' => 'Team Members',
'description' => 'Project team members',
'required' => false,
'multiple' => true,
'target_asset_types' => [
'system.contact'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Account-ID: <x-account-id>"
],
]);
$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://api.us.lexful.app/v1/asset_types"
payload := strings.NewReader("{\n \"name\": \"secure_project\",\n \"display_name\": \"Secure Projects\",\n \"description\": \"Project management with secure credentials and file attachments\",\n \"is_system\": false,\n \"properties\": [\n {\n \"name\": \"project_name\",\n \"type\": \"string\",\n \"display_name\": \"Project Name\",\n \"description\": \"Name of the project\",\n \"required\": true\n },\n {\n \"name\": \"budget\",\n \"type\": \"number\",\n \"display_name\": \"Budget\",\n \"description\": \"Project budget in dollars\",\n \"required\": false\n },\n {\n \"name\": \"team_size\",\n \"type\": \"integer\",\n \"display_name\": \"Team Size\",\n \"description\": \"Number of team members\",\n \"required\": false\n },\n {\n \"name\": \"is_active\",\n \"type\": \"boolean\",\n \"display_name\": \"Active\",\n \"description\": \"Whether project is currently active\",\n \"required\": true\n },\n {\n \"name\": \"milestones\",\n \"type\": \"array\",\n \"display_name\": \"Milestones\",\n \"description\": \"Project milestones and deliverables\",\n \"required\": false,\n \"array\": {\n \"type\": \"object\",\n \"properties\": [\n {\n \"name\": \"title\",\n \"type\": \"string\",\n \"display_name\": \"Milestone Title\",\n \"required\": true\n },\n {\n \"name\": \"completion_percentage\",\n \"type\": \"integer\",\n \"display_name\": \"Completion %\",\n \"required\": true\n }\n ]\n }\n },\n {\n \"name\": \"api_key\",\n \"type\": \"secret\",\n \"display_name\": \"API Key\",\n \"description\": \"Encrypted API key for external integration\",\n \"required\": false\n },\n {\n \"name\": \"mfa_token\",\n \"type\": \"totp\",\n \"display_name\": \"MFA Token\",\n \"description\": \"Time-based one-time password for authentication\",\n \"required\": false\n },\n {\n \"name\": \"project_plan\",\n \"type\": \"file\",\n \"display_name\": \"Project Plan\",\n \"description\": \"Project planning document\",\n \"required\": false,\n \"file_rules\": {\n \"max_size\": 10485760,\n \"allowed_extensions\": [\n \".pdf\",\n \".docx\",\n \".xlsx\"\n ],\n \"allowed_mime_types\": [\n \"application/pdf\",\n \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n ]\n }\n },\n {\n \"name\": \"start_date\",\n \"type\": \"date\",\n \"display_name\": \"Start Date\",\n \"description\": \"Project start date\",\n \"required\": true\n },\n {\n \"name\": \"last_activity\",\n \"type\": \"datetime\",\n \"display_name\": \"Last Activity\",\n \"description\": \"Last activity timestamp\",\n \"required\": false\n },\n {\n \"name\": \"description\",\n \"type\": \"richtext\",\n \"display_name\": \"Description\",\n \"description\": \"Project description with formatting\",\n \"required\": false\n },\n {\n \"name\": \"detailed_specification\",\n \"type\": \"richtext_large\",\n \"display_name\": \"Detailed Specification\",\n \"description\": \"Complete project specification document\",\n \"required\": false\n }\n ],\n \"references\": [\n {\n \"name\": \"project_lead\",\n \"display_name\": \"Project Lead\",\n \"description\": \"Primary contact responsible for project\",\n \"required\": true,\n \"multiple\": false,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n },\n {\n \"name\": \"team_members\",\n \"display_name\": \"Team Members\",\n \"description\": \"Project team members\",\n \"required\": false,\n \"multiple\": true,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Account-ID", "<x-account-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.lexful.app/v1/asset_types")
.header("X-Account-ID", "<x-account-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"secure_project\",\n \"display_name\": \"Secure Projects\",\n \"description\": \"Project management with secure credentials and file attachments\",\n \"is_system\": false,\n \"properties\": [\n {\n \"name\": \"project_name\",\n \"type\": \"string\",\n \"display_name\": \"Project Name\",\n \"description\": \"Name of the project\",\n \"required\": true\n },\n {\n \"name\": \"budget\",\n \"type\": \"number\",\n \"display_name\": \"Budget\",\n \"description\": \"Project budget in dollars\",\n \"required\": false\n },\n {\n \"name\": \"team_size\",\n \"type\": \"integer\",\n \"display_name\": \"Team Size\",\n \"description\": \"Number of team members\",\n \"required\": false\n },\n {\n \"name\": \"is_active\",\n \"type\": \"boolean\",\n \"display_name\": \"Active\",\n \"description\": \"Whether project is currently active\",\n \"required\": true\n },\n {\n \"name\": \"milestones\",\n \"type\": \"array\",\n \"display_name\": \"Milestones\",\n \"description\": \"Project milestones and deliverables\",\n \"required\": false,\n \"array\": {\n \"type\": \"object\",\n \"properties\": [\n {\n \"name\": \"title\",\n \"type\": \"string\",\n \"display_name\": \"Milestone Title\",\n \"required\": true\n },\n {\n \"name\": \"completion_percentage\",\n \"type\": \"integer\",\n \"display_name\": \"Completion %\",\n \"required\": true\n }\n ]\n }\n },\n {\n \"name\": \"api_key\",\n \"type\": \"secret\",\n \"display_name\": \"API Key\",\n \"description\": \"Encrypted API key for external integration\",\n \"required\": false\n },\n {\n \"name\": \"mfa_token\",\n \"type\": \"totp\",\n \"display_name\": \"MFA Token\",\n \"description\": \"Time-based one-time password for authentication\",\n \"required\": false\n },\n {\n \"name\": \"project_plan\",\n \"type\": \"file\",\n \"display_name\": \"Project Plan\",\n \"description\": \"Project planning document\",\n \"required\": false,\n \"file_rules\": {\n \"max_size\": 10485760,\n \"allowed_extensions\": [\n \".pdf\",\n \".docx\",\n \".xlsx\"\n ],\n \"allowed_mime_types\": [\n \"application/pdf\",\n \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n ]\n }\n },\n {\n \"name\": \"start_date\",\n \"type\": \"date\",\n \"display_name\": \"Start Date\",\n \"description\": \"Project start date\",\n \"required\": true\n },\n {\n \"name\": \"last_activity\",\n \"type\": \"datetime\",\n \"display_name\": \"Last Activity\",\n \"description\": \"Last activity timestamp\",\n \"required\": false\n },\n {\n \"name\": \"description\",\n \"type\": \"richtext\",\n \"display_name\": \"Description\",\n \"description\": \"Project description with formatting\",\n \"required\": false\n },\n {\n \"name\": \"detailed_specification\",\n \"type\": \"richtext_large\",\n \"display_name\": \"Detailed Specification\",\n \"description\": \"Complete project specification document\",\n \"required\": false\n }\n ],\n \"references\": [\n {\n \"name\": \"project_lead\",\n \"display_name\": \"Project Lead\",\n \"description\": \"Primary contact responsible for project\",\n \"required\": true,\n \"multiple\": false,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n },\n {\n \"name\": \"team_members\",\n \"display_name\": \"Team Members\",\n \"description\": \"Project team members\",\n \"required\": false,\n \"multiple\": true,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.lexful.app/v1/asset_types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Account-ID"] = '<x-account-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"secure_project\",\n \"display_name\": \"Secure Projects\",\n \"description\": \"Project management with secure credentials and file attachments\",\n \"is_system\": false,\n \"properties\": [\n {\n \"name\": \"project_name\",\n \"type\": \"string\",\n \"display_name\": \"Project Name\",\n \"description\": \"Name of the project\",\n \"required\": true\n },\n {\n \"name\": \"budget\",\n \"type\": \"number\",\n \"display_name\": \"Budget\",\n \"description\": \"Project budget in dollars\",\n \"required\": false\n },\n {\n \"name\": \"team_size\",\n \"type\": \"integer\",\n \"display_name\": \"Team Size\",\n \"description\": \"Number of team members\",\n \"required\": false\n },\n {\n \"name\": \"is_active\",\n \"type\": \"boolean\",\n \"display_name\": \"Active\",\n \"description\": \"Whether project is currently active\",\n \"required\": true\n },\n {\n \"name\": \"milestones\",\n \"type\": \"array\",\n \"display_name\": \"Milestones\",\n \"description\": \"Project milestones and deliverables\",\n \"required\": false,\n \"array\": {\n \"type\": \"object\",\n \"properties\": [\n {\n \"name\": \"title\",\n \"type\": \"string\",\n \"display_name\": \"Milestone Title\",\n \"required\": true\n },\n {\n \"name\": \"completion_percentage\",\n \"type\": \"integer\",\n \"display_name\": \"Completion %\",\n \"required\": true\n }\n ]\n }\n },\n {\n \"name\": \"api_key\",\n \"type\": \"secret\",\n \"display_name\": \"API Key\",\n \"description\": \"Encrypted API key for external integration\",\n \"required\": false\n },\n {\n \"name\": \"mfa_token\",\n \"type\": \"totp\",\n \"display_name\": \"MFA Token\",\n \"description\": \"Time-based one-time password for authentication\",\n \"required\": false\n },\n {\n \"name\": \"project_plan\",\n \"type\": \"file\",\n \"display_name\": \"Project Plan\",\n \"description\": \"Project planning document\",\n \"required\": false,\n \"file_rules\": {\n \"max_size\": 10485760,\n \"allowed_extensions\": [\n \".pdf\",\n \".docx\",\n \".xlsx\"\n ],\n \"allowed_mime_types\": [\n \"application/pdf\",\n \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n ]\n }\n },\n {\n \"name\": \"start_date\",\n \"type\": \"date\",\n \"display_name\": \"Start Date\",\n \"description\": \"Project start date\",\n \"required\": true\n },\n {\n \"name\": \"last_activity\",\n \"type\": \"datetime\",\n \"display_name\": \"Last Activity\",\n \"description\": \"Last activity timestamp\",\n \"required\": false\n },\n {\n \"name\": \"description\",\n \"type\": \"richtext\",\n \"display_name\": \"Description\",\n \"description\": \"Project description with formatting\",\n \"required\": false\n },\n {\n \"name\": \"detailed_specification\",\n \"type\": \"richtext_large\",\n \"display_name\": \"Detailed Specification\",\n \"description\": \"Complete project specification document\",\n \"required\": false\n }\n ],\n \"references\": [\n {\n \"name\": \"project_lead\",\n \"display_name\": \"Project Lead\",\n \"description\": \"Primary contact responsible for project\",\n \"required\": true,\n \"multiple\": false,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n },\n {\n \"name\": \"team_members\",\n \"display_name\": \"Team Members\",\n \"description\": \"Project team members\",\n \"required\": false,\n \"multiple\": true,\n \"target_asset_types\": [\n \"system.contact\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
"account_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
"name": "system.contact",
"display_name": "Contacts",
"description": "Contacts are people and identities associated with an organization",
"is_system": true,
"properties": [
{
"name": "first_name",
"type": "string",
"display_name": "First Name",
"required": false
},
{
"name": "last_name",
"type": "string",
"display_name": "Last Name",
"required": false
},
{
"name": "title",
"type": "string",
"display_name": "Title",
"required": false
},
{
"name": "important",
"type": "boolean",
"display_name": "Important",
"required": true
},
{
"name": "contact_type",
"type": "string",
"display_name": "Contact Type",
"required": false,
"enum": [
"Approver",
"Champion",
"Decision Maker",
"End User",
"Evaluator",
"Influencer",
"Owner",
"Other"
]
},
{
"name": "contact_methods",
"type": "array",
"display_name": "Contact Methods",
"required": false,
"array": {
"type": "object",
"properties": [
{
"name": "type",
"type": "string",
"display_name": "Contact Method Type",
"required": true,
"enum": [
"Phone",
"Fax",
"Mobile",
"Email",
"Website",
"Twitter",
"LinkedIn",
"Other"
]
},
{
"name": "value",
"type": "string",
"display_name": "Contact Method Value",
"required": true
}
]
}
},
{
"name": "preferred_contact_method",
"type": "string",
"display_name": "Preferred Contact Method",
"required": false,
"enum": [
"Phone",
"Fax",
"Mobile",
"Email",
"Website",
"Twitter",
"LinkedIn",
"Other"
]
},
{
"name": "notes",
"type": "richtext",
"display_name": "Notes",
"required": false
}
],
"references": [
{
"name": "location",
"display_name": "Location",
"required": false,
"multiple": false,
"target_asset_types": [
"system.location"
]
}
],
"version": 1,
"created_at": "2024-01-15T10:30:00.000Z",
"updated_at": "2024-01-15T10:30:00.000Z",
"created_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
"updated_by": "019983a9-c4c0-73af-aec9-463feeadc2e7"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}Body
application/json
Response
Default Response
Was this page helpful?