Create collection

POST

https://api.sureshake.com/v2/entities/{entityId}/collections

Path parameters

entityId
string
required
format: uuid

Request body JSON required

name
string
required
maxLength: 255 · minLength: 1
description
optional
string
or null
parentId
optional
string
or null
format: uuid
templateKey
optional
string
or null
pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- name
  string
  required
  maxLength: 255 · minLength: 1
- description
  string
  or null
  required
- entityId
  string
  required
  format: uuid
- userId
  string
  required
- parentId
  string
  or null
  required
  format: uuid
- templateKey
  string
  or null
  required
- externalSharingEnabled
  boolean
  required
- status
  string
  required
- version
  number
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- reportCount
  optional
  number
- childCount
  optional
  number
- subtreeReportCount
  optional
  number
- ancestors
  optional
  array of
  object
  id
  string
  required
  format: uuid
  name
  string
  required
- children
  optional
  array of
  object
  id
  string
  required
  format: uuid
  name
  string
  required
  description
  string
  or null
  required
  status
  string
  required
  reportCount
  integer
  required
  minimum: 0
  childCount
  integer
  required
  minimum: 0
  subtreeReportCount
  integer
  required
  minimum: 0
  updatedAt
  string
  required
  format: date-time
- reports
  optional
  array of
  object
  id
  string
  required
  format: uuid
  title
  string
  required
  report_type
  forecast
  or
  projection
  or
  actual
  or
  formal_report
  or
  periodic_report
  or
  annual_report
  +28 more
  required
  status
  draft
  or
  uploading
  or
  attributes_added
  or
  ipfs_generated
  or
  submitted
  or
  verified
  +2 more
  required
  is_public
  boolean
  required
  owner_id
  string
  required
  created_at
  string
  required
  format: date-time
  updated_at
  string
  required
  format: date-time
  description
  optional
  string
  or null
  entity_id
  optional
  string
  or null
  format: uuid
  linked_report_id
  optional
  string
  or null
  format: uuid
  fiscal_period_start
  optional
  string
  or null
  format: date-time
  fiscal_period_end
  optional
  string
  or null
  format: date-time
  ipfs_hash
  optional
  string
  or null
  ipfs_url
  optional
  string
  or null
  document_key
  optional
  string
  or null
  document_type
  optional
  string
  or null
  nft_address
  optional
  string
  or null
  nft_token_id
  optional
  string
  or null
  transaction_hash
  optional
  string
  or null
  data
  optional
  map of
  unknown
  or null
  view_delivery
  optional
  Any of the following:
  object
  status
  ready
  required
  receiptId
  string
  required
  format: uuid
  source
  share
  or
  vault
  or
  direct
  or
  api
  required
  expiresAt
  string
  required
  format: date-time
  policyVersion
  report-view-delivery-v2
  required
  object
  status
  policyExcluded
  required
  reason
  owner_self
  or
  blocked
  or
  non_external_traffic
  required
  policyVersion
  report-view-delivery-v2
  required
  object
  status
  unavailable
  required
  reason
  viewer_policy_unavailable
  or
  lineage_unavailable
  or
  tracking_unavailable
  required
  policyVersion
  report-view-delivery-v2
  required
  collection_ids
  optional
  array of
  string
  format: uuid
  tags
  optional
  array of
  object
  id
  string
  required
  format: uuid
  name
  string
  required
  visibility
  private
  or
  public
  required
- sharePermission
  optional
  viewer
  or
  download
- creditInfoSheets
  optional
  array of
  map<unknown>
- loanPackages
  optional
  array of
  map<unknown>
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request POST \ --url 'https://api.sureshake.com/v2/entities/<entityId>/collections' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "description": "string", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "templateKey": "string" } '

{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "userId": "string", "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43", "templateKey": "string", "externalSharingEnabled": true, "status": "string", "version": 0, "reportCount": 0, "childCount": 0, "subtreeReportCount": 0, "ancestors": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" } ], "children": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "status": "string", "reportCount": 0, "childCount": 0, "subtreeReportCount": 0, "updatedAt": "2019-08-24T14:15:22Z" } ], "reports": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "report_type": "forecast", "status": "draft", "is_public": true, "owner_id": "string", "entity_id": "8161163a-f227-466f-bc01-090a01e80165", "linked_report_id": "76246679-3292-4dc2-907d-bbc7b92e9b96", "fiscal_period_start": "2019-08-24T14:15:22Z", "fiscal_period_end": "2019-08-24T14:15:22Z", "ipfs_hash": "string", "ipfs_url": "string", "document_key": "string", "document_type": "string", "nft_address": "string", "nft_token_id": "string", "transaction_hash": "string", "data": { "property1": null, "property2": null }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "view_delivery": { "status": "ready", "receiptId": "4937ce52-e283-4321-b00f-c29b6dd5d0e9", "source": "share", "expiresAt": "2019-08-24T14:15:22Z", "policyVersion": "report-view-delivery-v2" }, "collection_ids": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ], "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "visibility": "private" } ] } ], "sharePermission": "viewer", "creditInfoSheets": [ { "property1": null, "property2": null } ], "loanPackages": [ { "property1": null, "property2": null } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }