API-V2 OpenAPI Specifications

Endpoints in the API-V2 "profiles" namespace return information from the logged in user's profile. You must be logged in to see any results. All responses are returned as JSON.

Endpoint and Parameter Descriptions

The following table identifies each supported endpoint, and any parameters that the endpoint request supports. Requests are constructed by appending "/api/v2/profiles" with the endpoint and any query parameters. To see which query parameter values are accepted for a query parameter, click on the links in the Param Type column for that parameter. To see what endpoint responses look like, click on the links in the Examples column.
EndpointOperationDescriptionExamples
GET

returns this OpenAPI specification as JSON
licenses GET

list all licenses signed by the current logged in user. This will return an empty list unless you are logged in and have previously signed any licenses.

Param NameParam DescriptionParam Type
email

email address of user.

 string matching /^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$/
fields

names of information fields desired in the output

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
formats

format for desired output

 one of [json, html, csv]
licenses/{licenseId} GET

display a specific license signed by the current logged in user. This will return an empty list unless you are logged in and have previously signed the specified licenses.

Param NameParam DescriptionParam Type
licenseId

license Id.

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
fields

names of information fields desired in the output

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
formats

format for desired output

 one of [json, html, csv]
POST
orders GET
Param NameParam DescriptionParam Type
fields

names of information fields desired in the output

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
formats

format for desired output

 one of [json, html, csv]
debugEmail

email address of user.

 string matching /^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$/
temporalRanges

temporal ranges (date and optionally, time) are specified as follows:

  • dates can have either of the two following formats:
    • YYYY-MM-DD where YYYY is year, MM is month number (01..12), and DD is day of month (01..number of days in month).
    • YYYY-DDD where YYYY is the 4 digit year and DDD is the day-of-year (1..365 or 1..366 for leap years)
    • if a date is NOT specified, then the current date is assumed.
  • the date is separated from the time by either a space or a "T" character.
  • times must be specified as HH:MM, where HH is the hour (0..23) counting from midnight, and MM is the minute (0..59).
  • all times are interpreted as Coordinated Universal Time (UTC). Currently time zone specifications are not supported.
  • date time ranges are specified as two dates or date times separated by two period (dot) characters ".."
    • date..date : the start time is assumed to be 00:00 and the end time is assumed to be 23:59
      • YYYY-MM-DD..YYYY-MM-DD
      • YYYY-DDD..YYYY-MM-DD
      • YYYY-MM-DD..YYYY-DDD
      • YYYY-DDD..YYYY-DDD
    • date time..date : the end time is assumed to be 23:59
      • YYYY-MM-DD HH:MM..YYYY-MM-DD
      • YYYY-DDD HH:MM..YYYY-MM-DD
      • YYYY-MM-DD HH:MM..YYYY-DDD
      • YYYY-DDD HH:MM..YYYY-DDD
    • date..date time : the start time is assumed to be 00:00
      • YYYY-MM-DD..YYYY-MM-DD HH:MM
      • YYYY-DDD..YYYY-MM-DD HH:MM
      • YYYY-MM-DD..YYYY-DDD HH:MM
      • YYYY-DDD..YYYY-DDD HH:MM
    • date time..date time
      • YYYY-MM-DD HH:MM..YYYY-MM-DD HH:MM
      • YYYY-DDD HH:MM..YYYY-MM-DD HH:MM
      • YYYY-MM-DD HH:MM..YYYY-DDD HH:MM
      • YYYY-DDD HH:MM..YYYY-DDD HH:MM
 /api/v2/measurements/temporalRanges

return all the orders for the logged in user
orders/{orderId} GET
Param NameParam DescriptionParam Type
orderId

order Id.

 integer
fields

names of information fields desired in the output

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
formats

format for desired output

 one of [json, html, csv]
debugEmail

email address of user.

 string matching /^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$/

return the order specified by orderId. This only works for the user that placed the order, or an admin
users GET
  • if logged in, returns information about the current user
Param NameParam DescriptionParam Type
fields

names of information fields desired in the output

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
formats

format for desired output

 one of [json, html, csv]
users/{userId} GET
  • if logged in, returns information about the current user if {userId} matches the current user's
Param NameParam DescriptionParam Type
userId

user's id.

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
fields

names of information fields desired in the output

 string matching /^[a-zA-Z0-9\.\,\s\?\*_:|-]+$/
formats

format for desired output

 one of [json, html, csv]
version GET

returns the GitLab Tag of this installed namespace.