/api/report-elements
GET
Retrieve the report elements contained in a set of archives.
Parameters
| Name | Type | Description | Profile |
|---|---|---|---|
| profile-name | query | Specifies which profile to use, which will enable some parameters or modify hypercube queries accordingly. The default depends on the underlying repository | |
| format | query | Returns the results in the supplied format | |
| format-indent | query | Whether or not to indent JSON or XML output (default: no indent). | |
| token | query | The token that allows you to use this API. Gives you read (GET) and/or write (POST, DELETE, PATCH) credentials. | |
| aid | query | Archive IDs, to retrieve archives, sections, components or slice facts. | |
| eid | query | The EIDs (scheme + local name) of a company, to retrieve entities, archives, sections, components or dice facts. | |
| cik | query | The CIK of a company, to retrieve entities, archives, sections, components or dice facts. | sec |
| ticker | query | The ticker of a company, to retrieve entities, archives, sections, components or dice facts. | sec, japan |
| edinetcode | query | The EDINET code of a company, to retrieve entities, archives, sections, components or dice facts. | japan |
| entity-tag | query | The tag of an entity (such as an index), to retrieve entities, archives, sections, components or dice facts. | sec, japan |
| sic | query | The SIC (industry group) of a company, to retrieve entities, archives, sections, components or dice facts. | sec |
| archiveFiscalYear | query | The fiscal year focus of the archive, to retrieve archives, sections, components or slice facts (default: ALL). | sec, japan |
| archiveFiscalPeriod | query | The fiscal period focus of the archive, to retrieve archives, sections, components or slice facts (default: ALL). | sec, japan |
| archive-tag | query | The tag of the archive, to retrieve archives, sections, components or slice facts (default: no filtering). | japan |
| section | query | The URI of a particular section, to retrieve a section, component or report element. | |
| hypercube | query | The name of a hypercube report element, to retrieve labels. | |
| disclosure | query | A disclosure, to identify sections or components (e.g. BalanceSheet). | sec, japan |
| reportElement | query | The name of the report element to search for, to retrieve a section, a component or a report element (e.g. us-gaap:Goodwill). | |
| builtin | query | Whether to include built-in report elements (false by default). | |
| onlyNames | query | Whether only the names of the report elements should be returned. If so, the values don't contain duplicates. (default: false) | |
| name | query | [Deprecated] The name of the report element to return (e.g. us-gaap:Assets) | |
| report | query | The report to use as a context to retrieve the facts. In particular, concept maps and rules found in this report will be used. (default: none). | |
| label | query | A search term to search in the labels of report elements (e.g. stock) | |
| onlyTextBlocks | query | Filters by text block/not text block (default: no filtering) | |
| abstract | query | [Deprecated] Filters by abstract/not abstract (default: no filtering) | |
| kind | query | Filters by concept kind (default: no filtering) | |
| report-element-search | query | Includes in the results the report elements that have a label matching this full-text query | japan, sec |
| report-element-search-offset | query | Includes in the results the report elements that have a label matching the report-element-search parameter skipping the first report-element-search-offset results (default: 0) | japan, sec |
| report-element-search-limit | query | Includes in the results the report elements that have a label matching the report-element-search parameter limited to a maximum of report-element-search-limit results (default: 100) | japan, sec |
| language | query | A language code (default: en-US) for displaying labels. | |
| Content-Type | header | Content-Type of the request | |
| count | query | If true, only outputs statistics (default: false). | |
| top | query | Output only the first [top] results (default: no limit). | |
| skip | query | Skip the first [skip] results. |
Status codes
| Code | Description |
|---|---|
| 200 | Returns all names of the report elements in the selected archives |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges |
| 404 | No such entity could be found. / No such archive could be found. / No such component could be found |
| 500 | An internal error occurred during the processing of the request |
POST
Add or update report elements. The report elements are identified with an AID, a section URI and a qualified name.
A new report element can be created by submitting a JSON object containing general information about the report element. This JSON object must be valid agains a JSound schema. It can be either taken from the output of a GET request to the same endpoint (in which case it will be valid), or created manually.
For convenience, we offer a user-friendly summary of the fields involved. The JSound schema is available on request.
Body properties
| Field | Type | Presence | Content |
|---|---|---|---|
| AID | string | required | The AID of the archive to which the report element belongs |
| SectionURI | string (URI) | required | The URI of the section to which the report element belongs |
| Name | string (QName lexical space) | required | The name of the report element (of the form foo:Bar) |
| Kind | One of: Concept, Abstract, LineItems, Hypercube, Dimension, Member | optional | One of the six kinds of report element |
| PeriodType | One of: instant, duration | optional | Only allowed for the Concept kind. Indicates the period type (whether facts against this concept must have instant or duration periods). |
| DataType | string (QName lexical space) | optional | Only allowed for the Concept kind. Indicates the data type (value facts against this concept must have). |
| Balance | One of: credit, debit | optional | Only allowed for the Concept kind, and if the data type is monetary. Indicates the balance. |
| IsNillable | boolean | optional | Only allowed for the Concept kind. Specifies whether null is accepted as a fact value. |
Additionally, the following fields are allowed for the purpose of feeding back the output of the report-elements endpoint as input:
- Components (string)
- IsAbstract (boolean)
- BaseType (string)
- ClosestSchemaBuiltinType (string)
- IsTextBlock (boolean)
- Labels (string)
- Facts (string)
- Labels (string)
- Label (string)
- Section (string)
- CIK (string)
- EntityRegistrantName (string)
- FiscalYear (integer)
- FiscalPeriod (string)
For report elements with the kind Concept, the data type must be one of the following:
- xbrli:decimalItemType
- xbrli:floatItemType
- xbrli:doubleItemType
- xbrli:integerItemType
- xbrli:positiveIntegerItemType
- xbrli:nonPositiveIntegerItemType
- xbrli:nonNegativeIntegerItemType
- xbrli:negativeIntegershortItemType
- xbrli:byteItemType
- xbrli:intItemType
- xbrli:longItemType
- xbrli:unsignedShorItemType
- xbrli:unsignedByteItemType
- xbrli:unsignedIntItemType
- xbrli:unsignedLongItemType
- xbrli:stringItemType (implied/only one allowed for Hypercube, Dimension, LineItems and Abstract kinds)
- xbrli:booleanItemType
- xbrli:hexBinaryItemType
- xbrli:base64BinaryItemType
- xbrli:anyURIItemType
- xbrli:QNameItemType
- xbrli:durationItemType
- xbrli:timeItemType
- xbrli:dateItemType
- xbrli:gYearMonthItemType
- xbrli:gYearItemType
- xbrli:gMonthItemType
- xbrli:gMonthDayItemType
- xbrli:gDayItemType
- xbrli:normalizedStringItemType
- xbrli:tokenItemType
- xbrli:languageItemType
- xbrli:NameItemType
- xbrli:NCNameItemType
- xbrli:monetaryItemType (allows Balance)
- xbrli:pureItemType
- xbrli:sharesItemType
- xbrli:fractionItemType
- nonnum:domainItemType (implied/only one allowed for Member kind)
- nonnum:escapedItemType
- nonnum:xmlNodesItemType
- nonnum:xmlItemType
- nonnum:textBlockItemType
- num:percentItemType
- num:perShareItemType
- num:areaItemType
- num:volumeItemType
- num:massItemType
- num:weightItemType
- num:energyItemType
- num:powerItemType
- num:lengthItemType
- num:noDecimalsMonetaryItemType (allows Balance)
- num:nonNegativeMonetaryItemType (allows Balance)
- num:nonNegativeNoDecimalsMonetaryItemType (allows Balance)
- num:enumerationItemType
Several report elements can be created at the same time by posting a sequence of non-comma-separated JSON objects as above.
Parameters
| Name | Type | Description | Profile |
|---|---|---|---|
| format | query | Returns the results in the supplied format | |
| format-indent | query | Whether or not to indent JSON or XML output (default: no indent). | |
| token | query | The token that allows you to use this API. Gives you read (GET) and/or write (POST, DELETE, PATCH) credentials. | |
| report-element | body | The report element objects, which must be supplied in the body of the request, and which must satisfy the constraints described in the field table. |
Status codes
| Code | Description |
|---|---|
| 200 | Report elements have been added. |
| 400 | One of the supplied report elements is invalid or (if JSON) already exists. Or one of the supplied report elements is a duplicate. Or one of the supplied report elements is inconsistent with existing report elements with the same name in the same archive. |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges. |
| 403 | Access denied. |
| 404 | No such archive or section could be found. |
| 500 | An internal error occurred during the processing of the request. |
DELETE
Deletes a report element.
Parameters
| Name | Type | Description | Profile |
|---|---|---|---|
| profile-name | query | Specifies which profile to use, which will enable some parameters or modify hypercube queries accordingly. The default depends on the underlying repository | |
| format | query | Returns the results in the supplied format | |
| format-indent | query | Whether or not to indent JSON or XML output (default: no indent). | |
| token | query | The token that allows you to use this API. Gives you read (GET) and/or write (POST, DELETE, PATCH) credentials. | |
| aid | query | Archive ID of the archive or taxonomy. | |
| section | query | The URI of a particular section. | |
| reportElement | query | The name of the report element (e.g. us-gaap:Goodwill). |
Status codes
| Code | Description |
|---|---|
| 204 | The report element has been deleted. |
| 400 | Cannot delete more than one report element at a time (safety mechanism). |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges. |
| 403 | Access denied. |
| 404 | No such archive or section or report element could be found. |
| 500 | An internal error occurred during the processing of the request. |