DemoBundle

  • contract_version
    Type: string
    required
  • entities
    Type: object
    required
    • propertyName
      Type: array object[]
      • propertyName
        Type: anything
  • included_entities
    Type: array string[]
    required
  • job
    Type: object · DemoJob
    required

    Stable control-plane resource for one generated company.

    • contract_version
      Type: string
      required

      Versioned Fictix partner contract identifier.

    • id
      Type: string
      required
    • object
      enum
      const:  
      demo_job
      required
      values
      • demo_job
    • status
      Type: string enum
      required
      values
      • created
      • generating
      • ready
      • error
      • unknown
    • company
      Type: object
    • created_at
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • credentials
      Type: object

      One-time project runtime credentials. Treat api_key as a server-side secret.

    • credit
      Type: object
    • dataset_summary
      Type: object
    • generated_at
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • handoff
      Type: object
    • links
      Type: object · PartnerLinkSet

      Relative links to the normalized demo-job resources.

    • quality
      Type: object
    • regeneration_required
      Type: boolean

      True when the retained company predates the current accounting contract and must be regenerated before import.

    • runtime
      Type: object
    • scenario_manifest
      Type: object

      Optional for backwards compatibility. New create responses omit answer keys; fetch the authorized manifest route instead.

    • simulation
      Type: object
    • updated_at
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • object
    enum
    const:  
    demo_bundle
    required
    values
    • demo_bundle
  • total_records
    Type: integer
    min:  
    0
    required

    Integer numbers.

  • lineage
    Type: object
    • propertyName
      Type: anything
  • record_limit_applied
    Type: integer
    min:  
    1

    Integer numbers.

  • propertyName
    Type: anything