DataHub

• /api/v1/data

  • • GET /api/v1/data.{_format}

      • List records.
      • Documentation
      • Sandbox

      Documentation

      List records.

      Requirements

      Name	Requirement	Type	Description
      _format	json|xml|lidoxml|html

      Filters

      Name	Information
      offset	Requirement \d+ Description Offset from which to start listing entries.
      limit	Requirement \d{1,2} Description How many entries to return. Default 5
      sort	Requirement [a-zA-Z\.]+,(asc|desc|ASC|DESC) Description Sorting field and direction.

      Status Codes

      Status Code	Description
      200	Returned when successful

      Input

      Requirements

      = -

      Filters

      = -

      = -

      = -

      Headers

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

    • POST /api/v1/data.{_format}

      • Create a record.
      • Documentation
      • Sandbox

      Documentation

      Create a record.

      Requirements

      Name	Requirement	Type	Description
      _format	json|xml|lidoxml|html

      Status Codes

      Status Code	Description
      201	Returned when successful
      400	Returned if the form could not be validated, or record already exists

      Input

      Requirements

      = -

      Headers

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

• /api/v1/data/{id}

  • • PUT /api/v1/data/{id}.{_format}

      • Update a record (replaces the entire resource).
      • Documentation
      • Sandbox

      Documentation

      Update a record (replaces the entire resource).

      Requirements

      Name	Requirement	Type	Description
      id	.+?	integer	ID of entry to update
      _format	json|xml|lidoxml|html

      Parameters

      Parameter	Type	Required?	Format	Description
      data	string	true
      format	choice	true

      Status Codes

      Status Code	Description
      201	Returned when a record was succesfully created
      204	Returned when an existing recurd was succesfully updated
      400	Returned if the record could not be stored or parsed

      Input

      Requirements

      = -

      = -

      Parameters

      = Type String Boolean File Textarea -

      = Type String Boolean File Textarea -

      New parameter

      Headers

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

• /api/v1/data/{recordIds}

  • • DELETE /api/v1/data/{recordIds}.{_format}

      • Delete a record.
      • Documentation
      • Sandbox

      Documentation

      Delete a record.

      Requirements

      Name	Requirement	Type	Description
      recordIds	.+?
      _format	json|xml|lidoxml|html

      Status Codes

      Status Code	Description
      204	Returned when successful
      404	Returned if the resource was not found

      Input

      Requirements

      = -

      = -

      Headers

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line

    • GET /api/v1/data/{recordIds}.{_format}

      • Get a single record.
      • Documentation
      • Sandbox

      Documentation

      Get a single record.

      Requirements

      Name	Requirement	Type	Description
      recordIds	.+?
      _format	json|xml|lidoxml|html

      Status Codes

      Status Code	Description
      200	Returned when successful
      404	Returned if the resource was not found

      Input

      Requirements

      = -

      = -

      Headers

      = -

      New header

      Content

      = Set header Replaces header if set

      Request URL

      Request body

      Response Headers [Expand] [Profiler]

      Response Body [Raw]

      Curl Command Line