Skip to main content
POST
/
v1
/
decisions
Create decision
curl --request POST \
  --url https://staging.api.us.aptlydone.com/decision/v1/decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "105fa115-52d0-4466-baff-740447a60774",
  "name": "Long-term Investments",
  "description": "The Long-term Investments authority involves approving strategic investments",
  "guidance": "Investment decisions for long-term, strategic investments...",
  "sectionId": "105fa115-52d0-4466-baff-740447a60774",
  "sectionName": "Financial Authority",
  "categoryId": "105fa115-52d0-4466-baff-740447a60774",
  "categoryName": "Budget Approval",
  "status": "DRAFT",
  "createdBy": "105fa115-52d0-4466-baff-740447a60774",
  "createdByUsername": "John Doe",
  "owner": "105fa115-52d0-4466-baff-740447a60774",
  "ownerUsername": "John Doe",
  "conditionEnabled": false,
  "roleEnabled": false,
  "delegable": false,
  "delegationPathway": [
    "Matrix",
    "Direct Line",
    "Functional"
  ],
  "decisionAuthorities": [],
  "decisionGroups": [],
  "decisionDocuments": [],
  "copiedFrom": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
  "updatedBy": "105fa115-52d0-4466-baff-740447a60774",
  "updatedByUsername": "John Doe"
}'
{
  "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
  "tenantId": "105fa115-52d0-4466-baff-740447a60774",
  "name": "Long-term Investments",
  "description": "The Long-term Investments authority involves approving strategic investments, including equity stakes, acquisitions, and other business ventures.",
  "guidance": "Investment decisions for long-term, strategic investments, such as acquisitions and equity stakes, require a structured process that ensures alignment with corporate strategy, rigorous financial analysis, risk assessment, and strong governance. These investments should enhance the company's competitive positioning, growth potential, and long-term vision. Financial modeling is critical, incorporating valuation methods, cash flow impacts, and sensitivity analysis to forecast returns under different scenarios.",
  "sectionId": "105fa115-52d0-4466-baff-740447a60774",
  "categoryId": "105fa115-52d0-4466-baff-740447a60774",
  "status": "PUBLISHED",
  "createdBy": null,
  "owner": null,
  "createdAt": "2024-12-18T09:50:43.338Z",
  "updatedBy": null,
  "updatedAt": "2024-12-18T09:50:43.338Z",
  "copiedFrom": null,
  "conditionEnabled": false,
  "roleEnabled": false,
  "delegable": true,
  "decisionDisplayId": "14623",
  "delegationPathway": [
    "Matrix",
    "Direct Line",
    "Functional"
  ],
  "link": "/decisions/view/eyJ0ZW5hbnRJZCI6MSwiZGVjaXNpb25JZCI6ImU4YTEzYmQ0LTExYzItNDNkMi1hM2RjLWUxOGQ2ODU1NTU4OCJ9",
  "decisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
  "sectionName": "Financial Authority",
  "categoryName": "Budget Approval",
  "createdByUsername": "John Doe",
  "ownerUsername": "John Doe",
  "updatedByUsername": null,
  "delegations": 0,
  "decisionGroups": [
    {
      "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
      "denormalizedDecisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
      "groupId": "105fa115-52d0-4466-baff-740447a60774",
      "groupName": "Engineering Team",
      "tenantGroupTypeId": "105fa115-52d0-4466-baff-740447a60774"
    }
  ],
  "decisionAuthorities": [
    {
      "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
      "denormalizedDecisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
      "authorityTypeId": "105fa115-52d0-4466-baff-740447a60774",
      "authorityType": "Approval",
      "authorityTypeOrder": 1,
      "authorityTypeIcon": "check-square",
      "authorityLimit": "Primary",
      "authorityLimitValueType": "Value (currency)",
      "authorityLimitOperator": "<",
      "authorityLimitValue": "1000",
      "authorityLimitValueUnit": "$"
    }
  ],
  "decisionDocuments": [
    {
      "id": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
      "denormalizedDecisionId": "7df90da4-0634-40b9-abf5-6e97a222cfb8",
      "documentId": "105fa115-52d0-4466-baff-740447a60774",
      "documentName": "Proxy Comm Delegation of Authority Policy",
      "documentUrl": "https://filesamples.com/samples/document/pdf/sample1.pdf",
      "documentTypeName": "Policy",
      "documentIcon": "file_text_outlined",
      "documentDescription": "Defines the framework for delegating authority across ProxyComm's global operations, outlining roles, responsibilities, and decision-making limits to ensure compliance, accountability, and operational consistency.",
      "documentFileType": "pdf",
      "documentFileLink": "https://example.com/files/project_document.pdf",
      "isPinned": true,
      "documentDisplayId": "10000",
      "documentStatus": "PUBLISHED"
    }
  ],
  "ownerUserProfileUrl": "http://test.jpg",
  "createdByUserProfileUrl": "http://test.jpg",
  "updatedByUserProfileUrl": "http://test.jpg",
  "permissions": [
    {
      "allowed": true,
      "relationship_key": "<string>"
    }
  ],
  "createdByDetails": {},
  "updatedByDetails": {},
  "ownerDetails": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
tenantId
string
required

Tenant ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
name
string
required

Decision name

Maximum length: 150
Example:

"Long-term Investments"

​
sectionId
string
required

Section ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
sectionName
string
required

Section Name

Maximum length: 50
Example:

"Financial Authority"

​
createdBy
string
required

Created by user ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
createdByUsername
string
required

Created By Username

Maximum length: 50
Example:

"John Doe"

​
description
string
default:""

Decision description

Maximum length: 250
Example:

"The Long-term Investments authority involves approving strategic investments"

​
guidance
string
default:""

Decision guidance

Example:

"Investment decisions for long-term, strategic investments..."

​
categoryId
string | null

Category ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
categoryName
string | null

Category Name

Maximum length: 50
Example:

"Budget Approval"

​
status
enum<string>
default:DRAFT

Decision status

Available options:
DRAFT,
PUBLISHED
Example:

"DRAFT"

​
owner
string

Owner user ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
ownerUsername
string

Owner Username

Maximum length: 50
Example:

"John Doe"

​
conditionEnabled
boolean
default:false

Indicates if Conditions are enabled

Example:

false

​
roleEnabled
boolean
default:false

Indicates if Roles are enabled

Example:

false

​
delegable
boolean
default:false

Indicates if the Decision is delegable

Example:

false

​
delegationPathway
any[][]

Delegation Pathway

Example:
["Matrix", "Direct Line", "Functional"]
​
decisionAuthorities
object[]

Decision Authorities

​
decisionGroups
object[]

Decision Groups

​
decisionDocuments
object[]

Decision Documents

​
copiedFrom
string | null

ID of Decision which was copied to create current decision

Example:

"7df90da4-0634-40b9-abf5-6e97a222cfb8"

​
updatedBy
string

Updated by user ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
updatedByUsername
string

Updated By Username

Maximum length: 50
Example:

"John Doe"

Response

201 - application/json

Decision created successfully

​
id
string
required

Unique identifier

Example:

"7df90da4-0634-40b9-abf5-6e97a222cfb8"

​
tenantId
string
required

Tenant ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
name
string
required

Decision name

Example:

"Long-term Investments"

​
description
string | null
required

Decision description

Example:

"The Long-term Investments authority involves approving strategic investments, including equity stakes, acquisitions, and other business ventures."

​
guidance
string | null
required

Decision guidance

Example:

"Investment decisions for long-term, strategic investments, such as acquisitions and equity stakes, require a structured process that ensures alignment with corporate strategy, rigorous financial analysis, risk assessment, and strong governance. These investments should enhance the company's competitive positioning, growth potential, and long-term vision. Financial modeling is critical, incorporating valuation methods, cash flow impacts, and sensitivity analysis to forecast returns under different scenarios."

​
sectionId
string
required

Section ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
categoryId
string | null
required

Category ID

Example:

"105fa115-52d0-4466-baff-740447a60774"

​
status
object
required

Decision status

Example:

"PUBLISHED"

​
createdBy
string | null
required

Created by user ID

Example:

null

​
owner
string | null
required

Owner user ID

Example:

null

​
createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-12-18T09:50:43.338Z"

​
updatedBy
string | null
required

Updated by user ID

Example:

null

​
updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-12-18T09:50:43.338Z"

​
copiedFrom
string | null
required

ID of Decision which was copied to create current decision

Example:

null

​
conditionEnabled
boolean
required

Indicates if Conditions are enable for the Decision

Example:

false

​
roleEnabled
boolean
required

Indicates if Roles are enable for the Decision

Example:

false

​
delegable
boolean
required

Indicates if the Decision is delegable or not

Example:

true

​
decisionDisplayId
string
required

Decision Display ID

Example:

"14623"

​
delegationPathway
object | null
required

Delegation Pathway values for the delegable Decision

Example:
["Matrix", "Direct Line", "Functional"]
​
link
string
required

Decision Link

Example:

"/decisions/view/eyJ0ZW5hbnRJZCI6MSwiZGVjaXNpb25JZCI6ImU4YTEzYmQ0LTExYzItNDNkMi1hM2RjLWUxOGQ2ODU1NTU4OCJ9"

​
decisionId
string
required

Original Decision ID for current denormalized record. This ID should be used for REST operations.

Example:

"7df90da4-0634-40b9-abf5-6e97a222cfb8"

​
sectionName
string
required

Section Name

Example:

"Financial Authority"

​
categoryName
string | null
required

Category Name

Example:

"Budget Approval"

​
createdByUsername
string | null
required

Created By Username

Example:

"John Doe"

​
ownerUsername
string | null
required

Owner Username

Example:

"John Doe"

​
updatedByUsername
string | null
required

Updated By Username

Example:

null

​
decisionGroups
object[]
required

Decision Groups

​
decisionAuthorities
object[]
required

Decision Authorities

​
decisionDocuments
object[]
required

Decision Documents

​
delegations
object

No. of delegations for the decision ('Reserved' if not delegable)

Example:

0

​
ownerUserProfileUrl
string | null

profile url of the owner user

Example:

"http://test.jpg"

​
createdByUserProfileUrl
string | null

profile url of the created by user

Example:

"http://test.jpg"

​
updatedByUserProfileUrl
string | null

profile url of the updated by user

Example:

"http://test.jpg"

​
permissions
object[] | null

permissions

​
createdByDetails
object | null

Created By user details

​
updatedByDetails
object | null

Updated By user details

​
ownerDetails
object | null

Owner By user details