Get document policy

GET

https://api.sureshake.com/v2/reports/{id}/document-policy

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- reportId
  string
  required
  format: uuid
- allowDownload
  boolean
  required
- watermark
  boolean
  required
- basis
  owner
  or
  team_member
  or
  shared_access
  required
- defaults
  object
  or null
  required
  allowDownload
  boolean
  required
  watermark
  boolean
  required
}
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
}

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
}

{ "data": { "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9", "allowDownload": true, "watermark": true, "basis": "owner", "defaults": { "allowDownload": true, "watermark": true } }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }