/api/rules

GET

Retrieve a summary for all rules of a given 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 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.  
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).  
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 rules for the given sections
401 Unauthorized: the specified project token is invalid, expired, or has insufficient privileges
404 No such entity or archive or section could be found
500 An internal error occurred during the processing of the request

POST

Parameters

Name Type Description Profile
token query The token that allows you to use this API. Gives you read (GET) and/or write (POST, DELETE, PATCH) credentials.  
rules body The rule objects.  

Status codes

Code Description
200 Rules have been added.
400 One of the supplied rules is invalid.
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.
409 One of the supplied rules already exists or is duplicated.
500 An internal error occurred during the processing of the request.

DELETE

Delete a rule for a given section

Parameters

Name Type Description Profile
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.  
id query Rule id.  

Status codes

Code Description
200 Rule has been added.
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.