/api/sections
GET
Retrieve a summary for all sections of a given archive
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 components / sections. | |
| 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). | |
| label | query | A search term to search in the labels of components, to retrieve components (e.g. stock). | |
| validate | query | Whether to run validation on the output components (default: false). Adds a column ValidationErrors | |
| language | query | A language code (default: en-US) for displaying labels. | |
| 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 sections for the given archive |
| 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 |
| 500 | An internal error occurred during the processing of the request |
POST
Add or update sections. A section is identified with an Archive ID (AID) and a section URI.
A section can be created by submitting a JSON object containing general information about the section. This JSON object must be valid against 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 section belongs |
| SectionURI | string | required | The URI of the section |
| Section | string | required | A user-friendly label for the section (preferably in English). |
| Profiles | object | optional | Maps profile names to additional profile-specific information. The profile-specific information must have a Name field containing the profile name, that is, identical to its key. The other fields in the profile information is not restricted. |
Additionally, the following fields are allowed for the purpose of feeding back the output of the sections endpoint as input:
- Components (string)
- ReportElements (string)
- FactTable (string)
- Spreadsheet (string)
- Category (string)
- SubCategory (string)
- Disclosure (string)
- NumRules (integer)
- NumReportElements (integer)
- NumHypercubes (integer)
- NumDimensions (integer)
- NumMembers (integer)
- NumLineItems (integer)
- NumAbstracts (integer)
- NumConcepts (integer)
- EntityRegistrantName (string)
- CIK (string)
- FiscalYear (integer)
- FiscalPeriod (string)
- AcceptanceDatetime (string)
- FormType (string)
Several empty sections can be created at the same time by posting a sequence of non-comma-separated JSON objects as above.
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. | |
| section | body | The section objects (they must be valid). |
Status codes
| Code | Description |
|---|---|
| 200 | Sections have been added. |
| 400 | One of the supplied sections is invalid or (if JSON) already exists. Or one of the supplied sections is a duplicate. |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges. |
| 403 | Access denied. |
| 404 | No such archive could be found. |
| 500 | An internal error occurred during the processing of the request. |
DELETE
Deletes a section.
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. |
Status codes
| Code | Description |
|---|---|
| 204 | Sections have been deleted. |
| 400 | Cannot delete more than one section 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 could be found. |
| 500 | An internal error occurred during the processing of the request. |