API REFERENCE · SCHEMA

SourceList schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

All endpoints and schemas

Each array item: object.

[].idRequired
string
[].nameRequired
string
[].authorityRequired
string
[].availabilityRequired
enum

Values: "available", "disabled".

[].capabilitiesRequired
string[]
[].capabilities item fields

Each array item: string.

[].categoryRequired
enum

Values: "financial_sanctions", "export_control", "debarment", "regulatory_enforcement", "public_office", "reference", "other", "mixed".

[].rightsStatusRequired
enum

Values: "approved", "review_required", "restricted".

[].jurisdictionOptional
string
[].homepageOptional
string
[].downloadUrlOptional
string
[].formatOptional
string
[].attributionOptional
string
[].termsUrlOptional
string
[].disabledReasonOptional
string
[].refreshHoursOptional
integer

Minimum: 0.

[].parserVersionOptional
string
[].freshOptional
boolean
[].qualificationOptional
object
[].qualification fields and rules
[].qualification.implementedRequired
boolean
[].qualification.fixtureTestedRequired
boolean
[].qualification.liveFetchTestedRequired
boolean
[].qualification.rightsApprovedRequired
boolean
[].qualification.activatedRequired
boolean
[].qualification.liveFetchedAtOptional
string

Format: date-time.

[].qualification.blockersRequired
string[]
[].qualification.blockers item fields

Each array item: string.

[].currentVersionOptional
object or null

May be null.

[].currentVersion fields and rules

Allowed alternatives

  • Provide [].currentVersion.source_id and [].currentVersion.id and [].currentVersion.retrieved_at and [].currentVersion.status and [].currentVersion.rights_approved.
    [].currentVersion.source_idRequired
    string
    [].currentVersion.idRequired
    string
    [].currentVersion.retrieved_atRequired
    string

    Format: date-time.

    [].currentVersion.last_checked_atOptional
    string or null

    May be null.

    [].currentVersion.last_checked_at fields and rules

    Allowed alternatives

    • string

      Format: date-time.

    • null

      May be null.

    [].currentVersion.published_atOptional
    string or null

    May be null.

    [].currentVersion.published_at fields and rules

    Allowed alternatives

    • string

      Format: date-time.

    • null

      May be null.

    [].currentVersion.statusRequired
    string
    [].currentVersion.rights_approvedRequired
    boolean
  • null

    May be null.

[].lastImportOptional
object or null

May be null.

[].lastImport fields and rules

Allowed alternatives

  • Provide [].lastImport.source_id and [].lastImport.id and [].lastImport.retrieved_at and [].lastImport.status and [].lastImport.rights_approved.
    [].lastImport.source_idRequired
    string
    [].lastImport.idRequired
    string
    [].lastImport.retrieved_atRequired
    string

    Format: date-time.

    [].lastImport.last_checked_atOptional
    string or null

    May be null.

    [].lastImport.last_checked_at fields and rules

    Allowed alternatives

    • string

      Format: date-time.

    • null

      May be null.

    [].lastImport.published_atOptional
    string or null

    May be null.

    [].lastImport.published_at fields and rules

    Allowed alternatives

    • string

      Format: date-time.

    • null

      May be null.

    [].lastImport.statusRequired
    string
    [].lastImport.rights_approvedRequired
    boolean
  • null

    May be null.