API Documentation Github NPM

Class

OsduSchemaQueryBuilder

OsduSchemaQueryBuilder()

Class to build OSDU schema query bodies with friendly names for each available option

  • Note that querys built with this builder must at minimum specify the kind
Constructor

# new OsduSchemaQueryBuilder()

View Source models/schema/osduSchemaQueryBuilder.js, line 9

Methods

# authority(authority)

Pass an optional string to search for a specific authority

  • Accepts wildcards *
Parameters:
Name Type Description
authority string

The OSDU authority with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 20

# build() → {string}

Construct the query request query string based on the attributes set

View Source models/schema/osduSchemaQueryBuilder.js, line 130

The query string that is passed to the schema query request

string

# entityType(entityType)

Pass an optional string to search for a specific entityType

  • Accepts wildcards *
Parameters:
Name Type Description
entityType string

The OSDU entityType with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 40

# latestVersion(latestVersion)

If True, only return the latest version

Parameters:
Name Type Description
latestVersion boolean

Whether to retrieve only the latest version

View Source models/schema/osduSchemaQueryBuilder.js, line 102

# limit(limit)

Maximum number of schema records to return

Parameters:
Name Type Description
limit number

The integer number of records to return

View Source models/schema/osduSchemaQueryBuilder.js, line 111

# offset(offset)

Number of records to skip for pagination

Parameters:
Name Type Description
offset number

The integer number of records to skip

View Source models/schema/osduSchemaQueryBuilder.js, line 120

# schemaVersionMajor(schemaVersionMajor)

Pass an optional string to search for a specific schemaVersionMajor

  • Accepts wildcards *
Parameters:
Name Type Description
schemaVersionMajor string | number

The OSDU schemaVersionMajor with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 50

# schemaVersionMinor(schemaVersionMinor)

Pass an optional string to search for a specific schemaVersionMinor

  • Accepts wildcards *
Parameters:
Name Type Description
schemaVersionMinor string | number

The OSDU schemaVersionMinor with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 60

# scope(status)

The scope or schema visibility specification

  • Accepts only valid status INTERNAL or SHARED
Parameters:
Name Type Description
status 'INTERNAL' | 'SHARED'

The OSDU scope with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 87

# source(source)

Pass an optional string to search for a specific source

  • Accepts wildcards *
Parameters:
Name Type Description
source string

The OSDU source with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 30

# status(status)

The schema status specification

  • Accepts only valid status PUBLISHED, DEVELOPMENT, or OBSOLETE
Parameters:
Name Type Description
status 'PUBLISHED' | 'DEVELOPMENT' | 'OBSOLETE'

The OSDU status with which to filter the search

View Source models/schema/osduSchemaQueryBuilder.js, line 70