The XBRL Standard

https://specifications.xbrl.org
Admin
The XBRL Standard defines a set of interrelated technical specifications for the definition,...
Tokens:105,987
Snippets:984
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Test xfi:period-start: Start of Duration Context (V-03)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80126%20xfi.period-start/80126%20xfi

Tests if xfi:period-start returns the correct dateTime for the start of a duration context. It validates the output as a dateTime and compares it to the expected start dateTime.

```XPath
xfi:period-start( xfi:period( /xbrli:xbrl/concept:cD[1] ) )
```

--------------------------------

### XBRL Function: xfi:any-start-date

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves any start date from the XBRL instance. It takes no arguments and returns an optional xs:dateTime. This function is unsupported.

```XF
xfi:any-start-date() returns xs:dateTime?
```

--------------------------------

### Compare customer elements with different returns/net values using s-equal (V-11)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80201%20xfi.s-equal/80201%20xfi

This example demonstrates comparing 'customer' elements with different 'returns' and 'net' values using the 's-equal' function. It focuses on semantic equality.

```XPath
xfi:s-equal( //s:customer[@id eq 'bCustomer'],
                         //s:customer[@id eq 'dCustomer'] )
```

--------------------------------

### XBRL v-equal function usage (V-21)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80203%20xfi.v-equal/80203%20xfi

Demonstrates the use of the `xfi:v-equal` function to compare two concepts in an XBRL instance. This example checks for inequality, expecting a false boolean result.

```xquery
xfi:v-equal( //concept:d[@id eq 'd01'], //concept:d[@id eq 'd03'] )
```

--------------------------------

### GET /websites/specifications_xbrl/r:taxonomy

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110020-oim-r.taxonomy/oim-r

Returns the taxonomy for the report as a sequence of URLs to XML Schema documents. This function is exclusive to OIM Mode.

```APIDOC
## GET /websites/specifications_xbrl/r:taxonomy

### Description
Returns the taxonomy for the report, as a sequence of URLs to XML Schema documents. This function is exclusive to OIM Mode.

### Method
GET

### Endpoint
/websites/specifications_xbrl/r:taxonomy

### Parameters
#### Query Parameters
* **_r:taxonomy_()** (xs:anyURI) - Required - Specifies the taxonomy to retrieve.

### Response
#### Success Response (200)
* **xs:anyURI+** - A sequence of URLs corresponding to the taxonomy property of the report. The order of the returned values is the order of URLs in the taxonomy property.

#### Response Example
```json
[
  "http://example.com/schema1.xsd",
  "http://example.com/schema2.xsd"
]
```
```

--------------------------------

### Test xfi:unique-start-dates() with instant and duration facts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80305%20xfi.unique-start-dates/80305%20xfi

Tests the xfi:unique-start-dates() function with an instance containing both instant and duration facts. It verifies that the function correctly returns two distinct start dates.

```XQuery
xfi:unique-start-dates()
```

```XQuery
count( $result ) eq 2                         and                         $result[1] eq xs:dateTime("2008-01-01T00:00:00") and                         $result[2] eq xs:dateTime("2008-02-01T00:00:00")
```

--------------------------------

### Handle incorrect number of arguments with s-equal (V-13)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80201%20xfi.s-equal/80201%20xfi

This example shows an XPath-defined error for an incorrect number of arguments passed to the 's-equal' function, specifically when a sequence of contexts is provided as a single argument.

```XPath
xfi:s-equal( //xbrli:xbrl/xbrli:context[starts-with(@id,'c-V0')] )
```

--------------------------------

### Compare customer elements with different context IDs using s-equal (V-09)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80201%20xfi.s-equal/80201%20xfi

This example uses the 's-equal' function to compare 'customer' elements that have different context IDs ('bCustomer' and 'cCustomer'). It verifies semantic equality.

```XPath
xfi:s-equal( //s:customer[@id eq 'bCustomer'],
                         //s:customer[@id eq 'cCustomer'] )
```

--------------------------------

### Test V-01: Instance with instant and duration facts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80304%20xfi.any-start-date/80304%20xfi

Tests the `xfi:any-start-date()` function with an XBRL instance containing both instant and duration facts. It verifies that the function correctly identifies and returns the date-time values from the instance.

```xquery
xfi:any-start-date()
```

```xquery
count( $result ) eq 1 and $result = (xs:dateTime("2008-01-01T00:00:00"), xs:dateTime("2008-02-01T00:00:00") )
```

--------------------------------

### XBRL Function: xfi:unique-start-dates

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves unique start dates from the XBRL instance. It takes no arguments and returns a sequence of xs:dateTime. This function is supported.

```XF
xfi:unique-start-dates() returns xs:dateTime*
```

--------------------------------

### Convert Period String to Start DateTime (XSLT)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110050-oim-r.period-string-start/oim-r

This function takes a string representing a period and converts it into an xs:dateTime format, specifically returning the start time of the period. It is designed to work with strings in the Period String Representation format. It returns an error for invalid input formats.

```xs:dateTime
xs:dateTime=_r:period-string-start_( $period as _xs:string_)
```

--------------------------------

### V08: Test start-equality with unequal dates using xfi:start-equal

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80217%20xfi.start-equal/80217%20xfi

This snippet tests the `xfi:start-equal` function to ensure it correctly returns false when comparing a concept's date with an unequal context date. It requires the schema 'value-test-concepts.xsd' and instance file 'value-test-instance.xml'.

```XPath
xfi:start-equal( //concept:a[@id eq 'd6'], xfi:period-instant( xfi:period( /xbrli:xbrl/concept:a[@id eq 'd5'] ) ) )
```

```XPath
$result instance of xs:boolean and count( $result ) eq 1 and $result eq false()
```

--------------------------------

### Test xfi:precision Xbrl spec 2.1 example 13 line 3 (V-13)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80153%20xfi.precision/80153%20xfi

Tests the xfi:precision function with a numeric concept as per XBRL spec 2.1 example 13 line 3. Expects the result to be a nonNegativeInteger equal to 5.

```xml
xfi:precision( /xbrli:xbrl/concept:c2[7] )
```

--------------------------------

### Test xfi:period-start: Instant Context (V-01)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80126%20xfi.period-start/80126%20xfi

Tests if xfi:period-start returns the correct dateTime for an instant context. It verifies that the output is a dateTime and matches the expected value.

```XPath
xfi:period-start( /xbrli:xbrl/xbrli:context[@id eq 'context-earth']/xbrli:period )
```

--------------------------------

### Test xfi:precision Xbrl spec 2.1 example 13 line 2 (V-12)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80153%20xfi.precision/80153%20xfi

Tests the xfi:precision function with a numeric concept as per XBRL spec 2.1 example 13 line 2. Expects the result to be a nonNegativeInteger equal to 5.

```xml
xfi:precision( /xbrli:xbrl/concept:c2[6] )
```

--------------------------------

### Test xfi:precision Xbrl spec 2.1 example 13 line 1 (V-11)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80153%20xfi.precision/80153%20xfi

Tests the xfi:precision function with a numeric concept as per XBRL spec 2.1 example 13 line 1. Expects the result to be a nonNegativeInteger equal to 5.

```xml
xfi:precision( /xbrli:xbrl/concept:c2[5] )
```

--------------------------------

### Test V-02: Instance without facts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80304%20xfi.any-start-date/80304%20xfi

Tests the `xfi:any-start-date()` function with an empty XBRL instance. It ensures that the function correctly handles cases where no facts are present in the instance, returning an empty result.

```xquery
xfi:any-start-date()
```

```xquery
empty( $result )
```

--------------------------------

### V09: Test start-equality with equal dates using xfi:start-equal

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80217%20xfi.start-equal/80217%20xfi

This snippet tests the `xfi:start-equal` function to confirm it returns true when comparing a concept's date with an equal context date. It utilizes 'value-test-concepts.xsd' and 'value-test-instance.xml', expecting a true boolean result.

```XPath
xfi:start-equal( //concept:a[@id eq 'd6'], xfi:period-instant( xfi:period( /xbrli:xbrl/concept:a[@id eq 'd1'] ) ) )
```

```XPath
$result instance of xs:boolean and count( $result ) eq 1 and $result eq true()
```

--------------------------------

### Get XBRL Relationship Name

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the name (QName) of an XBRL relationship. Requires a relationship object.

```XQuery
xfi:relationship-name( $relationship as _xfi:relationship.type_) returns xs:QName
```

--------------------------------

### Get XBRL Relationship To Concept

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the target concept of an XBRL relationship. Requires a relationship object.

```XQuery
xfi:relationship-to-concept( $relationship as _xfi:relationship.type_) returns xs:QName
```

--------------------------------

### Test xfi:start-equal with date and equal constant

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80217%20xfi.start-equal/80217%20xfi

This test case evaluates the xfi:start-equal function's comparison between a date and a date constant. It confirms that the function returns true when they are equivalent.

```XPath
xfi:start-equal( //concept:a[@id eq 'd1'],
                         xs:date('2008-02-28') )
```

```XPath
$result instance of xs:boolean and
                          count( $result ) eq 1 and
                         $result eq true()
```

--------------------------------

### Test xfi:period-start: Instant Context for Concept (V-02)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80126%20xfi.period-start/80126%20xfi

Tests if xfi:period-start returns the correct dateTime for a concept whose context is an instant. It checks for a dateTime output matching the expected value.

```XPath
xfi:period-start( xfi:period( /xbrli:xbrl/concept:cI[1] ) )
```

--------------------------------

### Get XBRL Relationship From Concept

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the source concept of an XBRL relationship. Requires a relationship object.

```XQuery
xfi:relationship-from-concept( $relationship as _xfi:relationship.type_) returns xs:QName
```

--------------------------------

### xfi:x-equal - V-01: Equal nodes and order

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80210%20xfi.x-equal/80210%20xfi

Tests the x-equality of two nodes that are equal and in the correct order. This function expects schema, linkbase, and instance files as input and returns a boolean result.

```XPath
xfi:x-equal( //concept:dimVal[@id eq 'dv-V01-left']/concept:dimVal/concept:dblVal,
                         //concept:dimVal[@id eq 'dv-V01-right']/concept:dimVal/concept:dblVal )
```

--------------------------------

### Get XBRL Role Definition

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the definition of an XBRL role. Requires the role string as input.

```XQuery
xfi:role-definition( $role as _xs:string_) returns xs:string?
```

--------------------------------

### Get XBRL Arcrole Definition

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the definition of an XBRL arcrole. Requires the arcrole string as input.

```XQuery
xfi:arcrole-definition( $arcrole as _xs:string_) returns xs:string?
```

--------------------------------

### Test xfi:is-numeric with fraction concept (V-03)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80151%20xfi.is-numeric/80151%20xfi

Ensures that xfi:is-numeric returns true for a concept with an xs:fractionItemType data type. The test setup includes a schema, an instance file, and a function call.

```XQuery
xfi:is-numeric(fn:node-name(/xbrli:xbrl/concept:c3[1]))
```

```XQuery
$result eq true()
```

--------------------------------

### Get XBRL Fact Footnotes (Unsupported)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves footnotes associated with an XBRL fact. This function is currently unsupported.

```XQuery
xfi:fact-footnotes( $fact as _element()_ , $linkrole as _xs:string?_ , $arcrole as _xs:string?_ , $footnoterole as _xs:string?_ , $lang as _xs:string_) returns xs:string*
```

--------------------------------

### Test negative-filing-indicator with empty instance (XQuery)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80363%20xfi.negative-filing-indicator/80363%20xfi

Tests the 'xfi:negative-filing-indicator' function with an empty XBRL instance. The expected result is false, as the filing indicator is not present in the instance. This test uses a specific schema and instance file for validation.

```XQuery
xfi:negative-filing-indicator("Template 4")
```

```XQuery
$result eq false()
```

--------------------------------

### GET /r:facts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110070-oim-r.facts/oim-r

Retrieves all facts present in the XBRL report. This endpoint is exclusive to OIM Mode.

```APIDOC
## GET /r:facts

### Description
Returns all facts in the XBRL report. This includes facts for the built-in `xbrl:note` concept used for XBRL v2.1 text footnotes. The order of returned facts is not specified.

### Method
GET

### Endpoint
/r:facts

### Parameters

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **Type:** xbrl:fact*
  - Description: A sequence of all facts in the report.

#### Response Example
```json
{
  "facts": [
    {
      "factId": "fact1",
      "concept": "xbrl:someConcept",
      "value": "123.45"
    },
    {
      "factId": "fact2",
      "concept": "xbrl:note",
      "value": "This is a footnote."
    }
  ]
}
```
```

--------------------------------

### xfi:p-equal Test: Sequence Arguments (Equal)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80213%20xfi.p-equal/80213%20xfi

Tests if the xfi:p-equal function correctly returns true when given sequences of XBRL concepts that are p-equal. It takes schema and instance file paths as input.

```XPath
xfi:p-equal( ( //concept:b[@id eq 't18'], //concept:b[@id eq 't15']),
                        ( //concept:a[@id eq 't19'], //concept:b[@id eq 't16']) )
```

--------------------------------

### Test xfi:pcu-equal with nodes in different contexts (V-02b)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80216%20xfi.pcu-equal/80216%20xfi

Tests the xfi:pcu-equal function with nodes that have different contexts. This scenario is designed to return false, ensuring the function correctly handles context variations. Inputs include schema, linkbase, and instance files.

```XQuery
xfi:pcu-equal( //concept:P1[@id eq 'V01-left'],
                        //concept:P1[@id eq 'V03-right'] )
```

--------------------------------

### GET /websites/specifications_xbrl

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110010-oim-r.distinct-dimension-values/oim-r

Returns the distinct values for a dimension that are used by facts in the report. This function is exclusive to OIM Mode.

```APIDOC
## GET /websites/specifications_xbrl

### Description
Returns the distinct values for a dimension that are used by facts in the report. This function is exclusive to OIM Mode.

### Method
GET

### Endpoint
/websites/specifications_xbrl

### Parameters
#### Query Parameters
- **dimension** (xs:QName) - Required - The dimension to return used values for. This can be either an OIM Core Dimensions and Taxonomy-defined Dimensions.

### Response
#### Success Response (200)
- **xs:anyType*** - A sequence of distinct values for the specified dimension that appear on facts in the report. In the case of an explicit taxonomy-defined dimension, this will not include any default values. The order of the returned values is not specified.

#### Response Example
{
  "example": "[Sequence of distinct dimension values]"
}

### Errors
- **re:invalidDimension** - Error thrown if the specified QName does not correspond to either an OIM Core Dimension, or a taxonomy-defined dimension defined in the DTS of the report.
```

--------------------------------

### XBRL xfi:s-equal-set Function Example

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80206%20xfi.s-equal-set/80206%20xfi

Demonstrates the usage of the xfi:s-equal-set function for set comparison of XBRL sequences. It takes sequences as input and checks for equality when elements are treated as sets.

```xquery
xfi:s-equal-set( //xbrli:context[starts-with(@id,'c-V0')] )
```

```xquery
xfi:s-equal-set( ( //t:P3[@id='V08-left'], //t:P3[@id='V02-left']), ( //t:P3[@id='V08-left'], //t:P3[@id='V02-left'], //t:P3[text() eq 'V02-value']) )
```

--------------------------------

### Get XBRL Relationship Link Name

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the link name (QName) of an XBRL relationship. Requires a relationship object.

```XQuery
xfi:relationship-link-name( $relationship as _xfi:relationship.type_) returns xs:QName
```

--------------------------------

### Test V-01: Instance with instant and duration facts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80306%20xfi.single-unique-start-date/80306%20xfi

Tests the xfi:single-unique-start-date() function with an instance containing both instant and duration facts. It verifies that the function correctly handles date-times with and without time components.

```XFI
xfi:single-unique-start-date()
```

--------------------------------

### xfi:p-equal Test: Equal Items

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80213%20xfi.p-equal/80213%20xfi

Tests if the xfi:p-equal function correctly returns true for two p-equal XBRL concepts. It takes schema and instance file paths as input.

```XPath
xfi:p-equal( //concept:b[@id eq 't18'],
                        //concept:a[@id eq 't19'] )
```

--------------------------------

### Get Distinct Non-Abstract Parent Concepts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves distinct non-abstract parent concepts, optionally filtered by linkrole and arcrole.

```XQuery
xfi:distinct-nonAbstract-parent-concepts( $linkrole as _xs:string?_ , $arcrole as _xs:string_) returns xs:QName*
```

--------------------------------

### Compare nested IDs with s-equal for inequality detection (V-15)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80201%20xfi.s-equal/80201%20xfi

This example uses the 's-equal' function to compare contexts with differing nested IDs, ensuring that such differences are detected as semantic inequality, addressing a specific bug.

```XPath
xfi:s-equal( //xbrli:context[@id='c-V04-left'],
                         //xbrli:context[@id='c-V04-right'] )
```

--------------------------------

### Get XBRL Fact Typed Dimensions (Deprecated)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves all typed dimensions associated with an XBRL fact. This function is deprecated.

```XQuery
xfi:fact-typed-dimensions( $item as _schema-element(xbrli:item)_) returns xs:QName*
```

--------------------------------

### Test xfi:v-equal with equal numeric items (V-01)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80203%20xfi.v-equal/80203%20xfi

Tests the v-equality of numeric items that are equal within precision and units. It uses a specified schema and instance file, and asserts the function returns true.

```XPath
xfi:v-equal( //concept:a[@id eq 't1'],                         //concept:a[@id eq 't2'] )
```

```XPath
$result instance of xs:boolean and                          count( $result ) eq 1 and                         $result eq true()
```

--------------------------------

### Get XBRL Fact Explicit Dimensions (Deprecated)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves all explicit dimensions associated with an XBRL fact. This function is deprecated.

```XQuery
xfi:fact-explicit-dimensions( $item as _schema-element(xbrli:item)_) returns xs:QName*
```

--------------------------------

### Test xfi:pcu-equal with sequence arguments (V-03)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80216%20xfi.pcu-equal/80216%20xfi

Tests the xfi:pcu-equal function with sequence arguments where both sequences contain equal and ordered nodes. This case is expected to return true, verifying sequence comparison logic. Inputs include schema, linkbase, and instance files.

```XQuery
xfi:pcu-equal( ( //concept:P1[@id eq 'V01-left'], //concept:P1[@id eq 'tup1V01-left']),
                        ( //concept:P1[@id eq 'V01-right'], //concept:P1[@id eq 'tup1V01-right'])
                      )
```

--------------------------------

### Get XBRL Fact Scenario Remainder (Unsupported)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the scenario remainder for an XBRL fact. This function is currently unsupported.

```XQuery
xfi:fact-scenario-remainder( $item as _schema-element(xbrli:item)_) returns element(*)*
```

--------------------------------

### Get XBRL Fact Segment Remainder (Unsupported)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the segment remainder for an XBRL fact. This function is currently unsupported.

```XQuery
xfi:fact-segment-remainder( $item as _schema-element(xbrli:item)_) returns element(*)*
```

--------------------------------

### Test xfi:pc-equal: V-01 equal nodes

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80215%20xfi.pc-equal/80215%20xfi

Tests the c-equality of two nodes that are equal and in the same order. This is a basic test case for the xfi:pc-equal function.

```XPath
xfi:pc-equal( //concept:P1[@id eq 'V01-left'],
                        //concept:P1[@id eq 'V01-right'] )
```

--------------------------------

### Test xfi:unique-start-dates() with empty instance

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80305%20xfi.unique-start-dates/80305%20xfi

Tests the xfi:unique-start-dates() function with an empty instance. It verifies that the function correctly returns an empty result set.

```XQuery
xfi:unique-start-dates()
```

```XQuery
empty( $result )
```

--------------------------------

### Get Default Dimension Value

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110011-oim-r.default-dimension-value/oim-r

Retrieves the default value for a given dimension. This function is exclusive to OIM Mode.

```APIDOC
## GET r:default-dimension-value

### Description
Returns the default value for a specified dimension. This function is only available in OIM Mode.

### Method
GET

### Endpoint
/websites/specifications_xbrl/r:default-dimension-value

### Parameters
#### Query Parameters
- **dimension** (xs:QName) - Required - The dimension to return the default value for.

### Response
#### Success Response (200)
- **return value** (xs:QName*) - The default value for the dimension, if any. Returns an empty sequence if there is no default value. Returns an empty sequence for OIM Core dimensions or typed taxonomy-defined dimensions.

#### Response Example
```json
{
  "returnValue": "some_qname_value"
}
```

### Errors
- **re:invalidDimension** - Error thrown if the specified QName does not correspond to either an OIM Core Dimension, or a taxonomy-defined dimension defined in the DTS of the report.
```

--------------------------------

### GET /websites/specifications_xbrl/r:defaulted-dimensions

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110012-oim-r.defaulted-dimensions/oim-r

Returns the names of all explicit taxonomy-defined dimensions in the DTS that have a default value defined.

```APIDOC
## GET /websites/specifications_xbrl/r:defaulted-dimensions

### Description
Returns the names of all explicit taxonomy-defined dimensions in the DTS that have a default value defined. The order of the returned values is not specified.

### Method
GET

### Endpoint
/websites/specifications_xbrl/r:defaulted-dimensions

### Parameters
#### Query Parameters
- None

#### Request Body
- None

### Response
#### Success Response (200)
- **Dimensions** (xs:QName*) - A sequence of all explicit taxonomy-defined dimensions in the DTS that have a default value defined.

#### Response Example
{
  "Dimensions": [
    "exampleDimension1",
    "exampleDimension2"
  ]
}
```

--------------------------------

### Test xfi:u-equal-set with non-numeric items

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80209%20xfi.u-equal-set/80209%20xfi

This test case verifies the `xfi:u-equal-set` function's behavior when comparing sequences of non-numeric items for u-equality. It utilizes a schema and an instance file.

```XQuery
xfi:u-equal-set( (//c:b[./text() eq 'foo'],(//c:a)[1]),
                        (//c:b[./text() eq 'bar'],(//c:a)[2]) )

```

--------------------------------

### Test xfi:start-equal with equal dates

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80217%20xfi.start-equal/80217%20xfi

This test verifies the xfi:start-equal function's ability to correctly identify when two dates are equal. It uses specific schema and instance files and checks if the function returns true.

```XPath
xfi:start-equal( //concept:a[@id eq 'd1'],
                         //concept:a[@id eq 'd2'] )
```

```XPath
$result instance of xs:boolean and
                          count( $result ) eq 1 and
                         $result eq true()
```

--------------------------------

### XBRL Function: xfi:single-unique-start-date

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Checks if there is a single unique start date. It takes no arguments and returns a boolean. This function is supported.

```XF
xfi:single-unique-start-date() returns xs:boolean
```

--------------------------------

### Test xfm:asin() with 1.0e0 argument

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/31011%20xfm.asin/31011%20xfm

Evaluates the xfm:asin() function with an argument of 1.0e0. This test verifies the function's output for an input of 1, expecting a result of approximately 1.5707963267948966e0. The xbrl-instance-2003-12-31.xsd schema is used.

```XPath
xfm:asin(1.0e0)

```

--------------------------------

### Get XBRL Relationship Attribute

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves a specific attribute value from an XBRL relationship. Requires the relationship object and the attribute QName.

```XQuery
xfi:relationship-attribute( $relationship as _xfi:relationship.type_ , $attribute as _xs:QName_) returns xs:anyType?
```

--------------------------------

### xfi:x-equal - V-06: Incorrect number of arguments

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80210%20xfi.x-equal/80210%20xfi

Tests the xfi:x-equal function with an incorrect number of arguments, leading to an XPath-defined error (xqt-err:XPST0017). This test uses schema, linkbase, and instance files.

```XPath
xfi:x-equal( //xbrli:xbrl/concept:P1[starts-with(@id,'V0')] )
```

--------------------------------

### Get XBRL Linkbase Link Roles

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves link roles associated with a given arcrole from the linkbase. Requires the arcrole as input.

```XQuery
xfi:linkbase-link-roles( $arcrole as _xs:string_) returns xs:anyURI*
```

--------------------------------

### xfi:concept-label Standard Label Test (XPath)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/90503%20xfi.concept-label/90503%20xfi

Tests the xfi:concept-label function with standard label parameters. It expects a specific string output ('a111') based on the provided inputs. Dependencies include a schema file for DTS discovery.

```XPath
xfi:concept-label(QName('http://abc.com/test','A111'), '', '', 'en')
```

--------------------------------

### Test xfi:start-equal with reversed date and dateTime arguments

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80217%20xfi.start-equal/80217%20xfi

This test checks the xfi:start-equal function with arguments reversed (dateTime compared to date). It ensures the function correctly returns true for equivalent date/time values.

```XPath
xfi:start-equal( //concept:a[@id eq 'd4'],
                         //concept:a[@id eq 'd1'] )
```

```XPath
$result instance of xs:boolean and
                          count( $result ) eq 1 and
                         $result eq true()
```

--------------------------------

### Get XBRL Concept Substitutions

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the substitution group members for a given XBRL concept. Requires the concept's QName.

```XQuery
xfi:concept-substitutions( $concept-name as _xs:QName_) returns xs:QName+
```

--------------------------------

### Get XBRL Concept Data Type

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the data type of an XBRL concept. Requires the concept's QName as input.

```XQuery
xfi:concept-data-type( $concept as _xs:QName_) returns xs:QName?
```

--------------------------------

### Test xfi:u-equal-set with equal numeric items

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80209%20xfi.u-equal-set/80209%20xfi

This test case verifies the `xfi:u-equal-set` function returns true when comparing two sequences of numeric items that are u-equal. It requires a schema and an instance file for testing.

```XQuery
xfi:u-equal-set( (//c:a[./text() eq '1001'],//c:a[./text() eq '1002']),
                        (//c:a[./text() eq '2002'],//c:a[./text() eq '2001']) )

```

--------------------------------

### Get XBRL Concept Balance

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the balance attribute for a given XBRL concept. Requires the concept's QName as input.

```XQuery
xfi:concept-balance( $concept-name as _xs:QName_) returns xs:string
```

--------------------------------

### Get Entity for Fact

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/100042-oim-f.entity/oim-f

Retrieves the entity for a specified fact in Clark notation. This function is only available in OIM Mode.

```APIDOC
## POST /websites/specifications_xbrl

### Description
Returns the entity for a fact in Clark notation.

### Method
POST

### Endpoint
/websites/specifications_xbrl

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **fact** (xbrl:fact) - Required - The fact to obtain the entity for.

### Request Example
```json
{
  "fact": "<some_fact_identifier>"
}
```

### Response
#### Success Response (200)
- **entity** (xs:string?) - The Entity Core Dimension for the fact, expressed using Clark notation. Returns an empty sequence if the fact does not have the Entity Core Dimension.

#### Response Example
```json
{
  "entity": "{http://example.com/namespace}EntityIdentifier"
}
```
```

--------------------------------

### Test xfm:asin() with 0 argument

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/31011%20xfm.asin/31011%20xfm

Evaluates the xfm:asin() function with an argument of 0. This test verifies that the function correctly returns 0.0e0 for an input of zero. The test uses the xbrl-instance-2003-12-31.xsd schema.

```XPath
xfm:asin(0)

```

--------------------------------

### Get XBRL Fact Typed Dimension Value (Unsupported)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the typed dimension value for an XBRL fact. This function is currently unsupported.

```XQuery
xfi:fact-typed-dimension-value( $item as _schema-element(xbrli:item)_ , $dimension as _xs:QName_) returns element(xbrldi:typedMember)?
```

--------------------------------

### Test xfi:context-period with instant context (V-01)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80121%20xfi.context-period/80121%20xfi

Tests if xfi:context-period correctly returns the period element for an instant XBRL context. It takes a context element as input and expects a single period element as output, matching a specific period element in the instance document.

```XPath
xfi:context-period( /xbrli:xbrl/xbrli:context[1] )
```

--------------------------------

### Get XBRL Fact Explicit Dimension Value (Deprecated)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the value of a specific explicit dimension for an XBRL fact. This function is deprecated.

```XQuery
xfi:fact-explicit-dimension-value( $item as _schema-element(xbrli:item)_ , $dimension as _xs:QName_) returns xs:QName?
```

--------------------------------

### Test xfi:pc-equal: V-03 sequence of equal nodes

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80215%20xfi.pc-equal/80215%20xfi

Tests the c-equality of two sequences of nodes, where each sequence contains equal nodes in the same order. This validates handling of multiple nodes as arguments.

```XPath
xfi:pc-equal( ( //concept:P1[@id eq 'V01-left'], //concept:P1[@id eq 'tup1V01-left']),
                        ( //concept:P1[@id eq 'V01-right'], //concept:P1[@id eq 'tup1V01-right']) )
```

--------------------------------

### Test xfi:role-definition with 'http://abc.com/role/link1'

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/90505%20xfi.role-definition/90505%20xfi

Tests the xfi:role-definition function with a valid role URI ('http://abc.com/role/link1'). It expects the result to be 'Hello from link1'. The input schema is definition-test1.xsd.

```XQuery
xfi:role-definition('http://abc.com/role/link1')
```

--------------------------------

### Get XBRL Concept Period Type

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the period type for a given XBRL concept. Requires the concept's QName as input.

```XQuery
xfi:concept-period-type( $concept-name as _xs:QName_) returns xs:string
```

--------------------------------

### GET /websites/specifications_xbrl

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/110072-oim-r.fact-with-id/oim-r

Retrieves an XBRL fact by its unique ID. This endpoint is part of the OIM 1.0 specification and is only accessible in OIM Mode.

```APIDOC
## GET /websites/specifications_xbrl

### Description
Returns the XBRL fact with the specified ID. This function is exclusive to OIM Mode.

### Method
GET

### Endpoint
/websites/specifications_xbrl

### Parameters
#### Query Parameters
- **_r:fact-with-id** (xbrl:fact) - Required - The ID of the XBRL fact to retrieve.

### Request Example
```
GET /websites/specifications_xbrl?_r:fact-with-id=_some_fact_id_
```

### Response
#### Success Response (200)
- **Type:** xbrl:fact - The XBRL fact with the specified ID, or an empty sequence if no such fact exists.

#### Response Example
```json
{
  "fact_id": "_some_fact_id_",
  "value": "example_value",
  "context": "example_context"
}
```
```

--------------------------------

### Test xfi:precision with tuple concept (V-07)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80153%20xfi.precision/80153%20xfi

Tests the xfi:precision function with a tuple concept. Expects an error code 'xqt-err:XPTY0004'.

```xml
xfi:precision( /xbrli:xbrl/concept:c4[1] )
```

--------------------------------

### Get Linked Facts

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/100031-oim-f.linked-facts/oim-f

Retrieves facts linked to a specified fact, with optional filtering by link group and link type.

```APIDOC
## GET /websites/specifications_xbrl/f:linked-facts

### Description
Returns all facts linked to the specified fact, optionally filtered by link type and link group.

### Method
GET

### Endpoint
/websites/specifications_xbrl/f:linked-facts

### Parameters
#### Query Parameters
- **fact** (xbrl:fact) - Required - The fact to obtain footnotes for.
- **link-group** (xs:anyURI?) - Optional - If specified, only footnotes linked to the fact in the specified link group will be returned. If omitted, or an empty sequence, footnotes for all link groups will be returned.
- **link-type** (xs:anyURI?) - Optional - If specified, only footnotes linked to the fact with the specified link type will be returned. If omitted, or an empty sequence, footnotes for all link types will be returned.

### Response
#### Success Response (200)
- **Type:** xbrl:fact*
Returns the facts that are the target of links from _fact_, optionally filtered by _link-group_ and _link-type_. The returned facts may include `xbrl:note` facts if there are any text footnotes in the selected relationships. Links are represented in xBRL-XML as footnote relationships (see xBRL-XML for more details). If both _link-group_ and _link-type_ are specified, then the order of the returned values reflects the order of the facts in the "target facts" property of relevant link group component; otherwise, the order of the returned values is not specified.
```

--------------------------------

### Test xfi:pcu-equal with equal nodes (V-01)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80216%20xfi.pcu-equal/80216%20xfi

Tests the xfi:pcu-equal function with two identical nodes. It verifies that the function returns true for c-equality of nodes that are equal and in the same order. Inputs include schema, linkbase, and instance files.

```XQuery
xfi:pcu-equal( //concept:P1[@id eq 'V01-left'],
                        //concept:P1[@id eq 'V01-right'] )
```

--------------------------------

### Test xfi:period-start: Error for Forever Context (V-04)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80126%20xfi.period-start/80126%20xfi

Tests that an error is raised when xfi:period-start is called with a 'forever' context, indicating an inapplicable context.

```XPath
xfi:period-start( xfi:period( /xbrli:xbrl/concept:cD[2] ) )
```

--------------------------------

### Get Unit Numerators

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/100050-oim-f.unit-numerators/oim-f

Retrieves the numerator measures for a given fact's unit. This function is exclusive to OIM Mode.

```APIDOC
## GET /websites/specifications_xbrl/f:unit-numerators

### Description
Returns the numerator measures of a fact's unit.

### Method
GET

### Endpoint
/websites/specifications_xbrl/f:unit-numerators

### Parameters
#### Query Parameters
- **fact** (xbrl:fact) - Required - The fact to obtain the unit numerators for.

### Response
#### Success Response (200)
- **xs:QName*** (sequence of xs:QName) - A sequence of QNames corresponding to the numerator measures of the fact's units, or an empty sequence if the fact does not have the Unit Core Dimension. The order of returned values is not specified.

#### Response Example
```json
{
  "result": [
    "ns1:measure1",
    "ns2:measure2"
  ]
}
```
```

--------------------------------

### Test xfi:concept-balance for unclassified concept

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/90201%20xfi.concept-balance/90201%20xfi

Tests if the xfi:concept-balance function correctly handles an unclassified concept, expecting an empty string as output. It takes a schema, an instance file, and a function call as input.

```XQuery
xfi:concept-balance(fn:node-name(/xbrli:xbrl/concept:c3[1]))
```

--------------------------------

### xfi:x-equal - V-04: Sequences of different lengths

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80210%20xfi.x-equal/80210%20xfi

Tests the x-equality function with sequences of nodes that have different lengths. Inputs include schema, linkbase, and instance files, and the expected output is false.

```XPath
xfi:x-equal( ( //concept:dimVal[@id eq 'dv-V01-left']/concept:dimVal/concept:dblVal, //concept:dimVal[@id eq 'dv-V01-left']/concept:dimVal/concept:decVal),
                                                  ( //concept:dimVal[@id eq 'dv-V01-right']/concept:dimVal/concept:dblVal) )
```

--------------------------------

### Get XBRL Relationship Link Attribute

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves a specific link attribute value from an XBRL relationship. Requires the relationship object and the attribute QName.

```XQuery
xfi:relationship-link-attribute( $relationship as _xfi:relationship.type_ , $attribute as _xs:QName_) returns xs:anyType?
```

--------------------------------

### Get XBRL Concept Label

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the label for an XBRL concept, optionally filtered by linkrole, labelrole, and language. Requires the concept QName and language.

```XQuery
xfi:concept-label( $concept as _xs:QName_ , $linkrole as _xs:string?_ , $labelrole as _xs:string?_ , $lang as _xs:string_) returns xs:string
```

--------------------------------

### Test xfi:u-equal-set with unequal length sequences

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80209%20xfi.u-equal-set/80209%20xfi

This test case evaluates `xfi:u-equal-set` with sequence arguments of different lengths. It asserts that the function returns false in such scenarios, relying on a provided schema and instance file.

```XQuery
xfi:u-equal-set( ( (//c:a)[1], (//c:a)[3]),
                        ( (//c:a)[2] ) )

```

--------------------------------

### Test V-01: Instance with positive filing indicators

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80362%20xfi.positive-filing-indicator/80362%20xfi

Tests the 'xfi:positive-filing-indicator' function with an instance containing positive filing indicators. Verifies the function returns true when expected.

```XQuery
xfi:positive-filing-indicator("Template 1")
```

--------------------------------

### Get XBRL Fact Typed Dimension Simple Value (Deprecated)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves the simple value of a typed dimension for an XBRL fact. This function is deprecated.

```XQuery
xfi:fact-typed-dimension-simple-value( $item as _schema-element(xbrli:item)_ , $dimension as _xs:QName_) returns xs:anyAtomicType?
```

--------------------------------

### f:id Function - Get Fact ID

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/100061-oim-f.id/oim-f

Retrieves the 'id' property of a given XBRL fact. This function is exclusive to OIM Mode.

```APIDOC
## f:id

### Description
Returns the "id" property of a fact.

### Method
N/A (Function)

### Endpoint
N/A (Function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
f:id(fact)
```

### Response
#### Success Response (200)
- **id** (xs:string) - The 'id' property of the fact.

#### Response Example
```json
{
  "id": "example_fact_id"
}
```
```

--------------------------------

### xfi:identical-node-set: Identical node sets in order (XQuery)

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80205%20xfi.identical-node-set/80205%20xfi

Tests if xfi:identical-node-set correctly returns true for two identical node sets provided in the same order. It uses a schema 'facts-in-instance.xsd' and an instance file 'tuple-instance.xml'. The output assertion checks for a single true result.

```XQuery
xfi:identical-node-set(
                         (/xbrli:xbrl,
                          //xbrli:context[@id eq 'context-vulcan'],
                          //concept:t1[@id eq 'i2']),
                         (/xbrli:xbrl,
                          //xbrli:context[@id eq 'context-vulcan'],
                          //concept:t1[@id eq 'i2'])
                         )
```

--------------------------------

### Get XBRL Concept Relationships

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/index

Retrieves relationships for a given XBRL concept, with options for filtering by linkrole, arcrole, axis, and generations. Requires the source concept QName.

```XQuery
xfi:concept-relationships( $source as _xs:QName_ , $linkrole as _xs:string?_ , $arcrole as _xs:string_ , $axis as _xs:string_ , $generations as _xs:nonNegativeInteger?_ , $linkname as _xs:QName?_ , $arcname as _xs:QName?_) returns xfi:relationship.type*
```

--------------------------------

### Test positive-filing-indicators with V-01 instance

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/80360%20xfi.positive-filing-indicators/80360%20xfi

Tests the 'xfi:positive-filing-indicators()' function with an XBRL instance containing both positive and negative filing indicators. It verifies the correct count and values of returned templates. The schema used is 'taxonomy-fi.xsd'.

```XPath
xfi:positive-filing-indicators()
```

```XPath
count( $result ) eq 2                         and                         $result[1] = "Template 1"                         and                         $result[2] = "Template 2"                         and                         $result[1] ne $result[2]
```

--------------------------------

### Get Taxonomy-Defined Dimensions

Source: https://specifications.xbrl.org/registries/functions-registry-1.0/100022-oim-f.taxonomy-defined-dimensions/oim-f

Returns the names of all taxonomy-defined dimensions present on a fact. This function is exclusive to OIM Mode. Dimensions with default values are not included in the response.

```APIDOC
## GET /websites/specifications_xbrl/f:taxonomy-defined-dimensions

### Description
Returns the names of all taxonomy-defined dimensions present on a fact. This function is exclusive to OIM Mode. Dimensions with default values are not included in the response.

### Method
GET

### Endpoint
/websites/specifications_xbrl/f:taxonomy-defined-dimensions

### Parameters
#### Query Parameters
- **fact** (xbrl:fact) - Required - The fact to obtain dimension names for.

### Response
#### Success Response (200)
- **xs:QName?** - The names of all taxonomy-defined dimensions on the provided fact. Dimensions taking the default value, if any, are not included.

#### Response Example
```json
{
  "dimensions": [
    "http://example.com/ns/dimension1",
    "http://example.com/ns/dimension2"
  ]
}
```
```
Tokens:
Raw