/api/labels

GET

Retrieve labels for the supplied components and report elements

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).  
label query A search term to search in the labels of components, to retrieve components (e.g. stock).  
language query A language code (default: en-US) for displaying labels.  
labelRole query A label role (default: no filtering by label role). A more comprehensive list of label roles can be found in the XBRL Standard.  
onlyTextBlocks query If set to true only labels for concepts defined as textBlockItemType are returned (default: false).  
kind query Filters by concept kind (default: no filtering)  
eliminateReportElementDuplicates query Whether to eliminate (concept name, language, label role) duplicates. By default no duplicate elimination  
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 components 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. / No such component could be found
500 An internal error occurred during the processing of the request

POST

Add or update labels. A label is identified with an Archive ID (AID), a section URI, a report element, a language and a label role.

A label can be created by submitting a JSON object containing general information about the label. 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
ReportElement string required The name of a report element
Language string required A language code, e.g., en-US or de
Role string required A label role
Value string required The label itself

Several labels 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.  
label body The label objects (they must be valid).  

Status codes

Code Description
200 Labels have been added.
400 One of the supplied labels is invalid or (if JSON) already exists.
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.
409 One of the supplied labels already exists.
500 An internal error occurred during the processing of the request.

DELETE

Deletes a label.

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).  
language query A language code (default: en-US) for displaying labels.  
labelRole query A label role (default: no filtering by label role). A more comprehensive list of label roles can be found in the XBRL Standard.  

Status codes

Code Description
204 The label has been deleted.
400 Cannot delete more than one label 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 or label could be found.
500 An internal error occurred during the processing of the request.