XBRL

Endpoints related to XBRL entities and operations.

XbrlProfile

An XBRL Profile.

Properties

Name	Type	Description	Restrictions
archived	boolean	Whether the XbrlProfile is archived.	required
id	string	The ID of the XbrlProfile.	required
label	string	The label of the XbrlProfile.	required

Example

{
  "archived": false,
  "id": "9fb1c529-5ccb-48e1-8b19-de1431c3693e",
  "label": "Example Profile"
}

XbrlProfilesListResult

A resulting list of XbrlProfile resources.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	Pagination link for the next set of XbrlProfile resources.
data	[XbrlProfile]	The XbrlProfile resources.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "archived": false,
      "id": "9fb1c529-5ccb-48e1-8b19-de1431c3693e",
      "label": "Example Profile"
    }
  ]
}

SectionXbrlProperties

An entity that contains XBRL properties for a Section.

Properties

Name	Type	Description	Restrictions
section	string	The ID of the Section.	required
xbrlDisabled	boolean	Whether XBRL is disabled for the section.	required

Example

{
  "section": "257a1db8080749c6887338495b929248",
  "xbrlDisabled": true
}

SectionXbrlPropertiesListResult

A resulting list of SectionXbrlProperties resources.

Properties

Name	Type	Description	Restrictions
data	[SectionXbrlProperties]	The SectionXbrlProperties resources.	required

Example

{
  "data": [
    {
      "section": "257a1db8080749c6887338495b929248",
      "xbrlDisabled": true
    }
  ]
}

SectionXbrlPropertiesUpdate

An update for a SectionXbrlProperties resource.

Properties

Name	Type	Description	Restrictions
patch	JSONPatchDocument	The JSON Patch document to apply to the SectionXbrlProperties resource.	required
section	string	The ID of the Section, which corresponds to SectionXbrlProperties.section.	required

Example

{
  "patch": [
    {
      "op": "replace",
      "path": "/xbrlDisabled",
      "value": true
    }
  ],
  "section": "257a1db8080749c6887338495b929248"
}

BatchUpdateSectionXbrlPropertiesRequest

A request to batch update multiple SectionXbrlProperties resources.

Properties

Name	Type	Description	Restrictions
data	[SectionXbrlPropertiesUpdate]	The updates for multiple SectionXbrlProperties resources.	required, Minimum items: 1, Maximum items: 200

Example

{
  "data": [
    {
      "patch": [
        {
          "op": "replace",
          "path": "/xbrlDisabled",
          "value": true
        }
      ],
      "section": "257a1db8080749c6887338495b929248"
    }
  ]
}

JSONPatchDocument

Represents a collection of JSON patch operations. For more information, refer to the PATCH Update documentation.

Properties

Name	Type	Description	Restrictions
anonymous	[JSONPatchOperation]	Represents a collection of JSON patch operations. For more information, refer to the PATCH Update documentation.

Example

[
  {
    "op": "replace",
    "path": "/name",
    "value": "New name"
  }
]

JSONPatchOperation

Represents a single JSON Patch operation. For more information, refer to the PATCH Update documentation.

Properties

Name	Type	Description	Restrictions
from	string
op	string		required
path	string		required
value	any

Enumerated Values

Property	Value
op	add
op	remove
op	replace
op	move
op	copy
op	test

Example

{
  "op": "replace",
  "path": "/name",
  "value": "New name"
}

ErrorResponse

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Properties

Name	Type	Description	Restrictions
code	string	One of a server-defined set of error codes.
details	[ErrorDetails]	Additional details of the error
documentationUrl	string	Link to some documentation relevant to the issue or endpoint in use.
message	string	A human-readable representation of the error.
target	string	The target of the error.
version	string	The API version in use when the error occurred.

Example

{
  "code": "BadArgument",
  "details": [
    {
      "code": "InvalidOrder",
      "message": "Ordering by 'name desc' is not supported",
      "target": "name"
    }
  ],
  "documentationUrl": "https://developers.workiva.com",
  "message": "The provided $orderBy option is not supported.",
  "target": "$orderBy",
  "version": "2026-01-01"
}

ErrorDetails

Additional details of the error

Properties

Name	Type	Description	Restrictions
code	string
message	string
target	string

Example

{
  "code": "InvalidOrder",
  "message": "Ordering by 'name desc' is not supported",
  "target": "name"
}