Project API

The Notehub project API provides RESTful methods that can be used to GET and POST project data.

Get Project

Get information about a Notehub project by ProjectUID.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>'
    -H 'Authorization: Bearer <access_token>'
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub.

technical_contact

object

Contact information for the technical contact assigned in Notehub.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": {
    "name": "John Doe",
    "email": "someone@example.com",
    "role": "Admin",
    "organization": "Blues"
  },
  "technical_contact": {
    "name": "Jane Doe",
    "email": "someone@example.com",
    "role": "Tech",
    "organization": "Blues"
  },
  "role": "owner"
}

Get Projects

Get all Notehub projects accessible by provided authentication token.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

curl -X GET
    -L 'https://api.notefile.net/v1/projects'
    -H 'Authorization: Bearer <access_token>'
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub.

technical_contact

object

Contact information for the technical contact assigned in Notehub.

role

string

The role of the project member creating the API request.

Example Response
{
  "projects": [
    {
      "uid": "app:00000000-0000-0000-0000-000000000000",
      "label": "First Notehub Project",
      "created": "2021-04-26T19:11:05Z",
      "administrative_contact": {
        "name": "John Doe",
        "email": "someone@example.com",
        "role": "Admin",
        "organization": "Blues"
      },
      "technical_contact": {
        "name": "Jane Doe",
        "email": "someone@example.com",
        "role": "Tech",
        "organization": "Blues"
      },
      "role": "owner"
    },
    {
      "uid": "app:00000000-0000-0000-0000-000000000000",
      "label": "Second Notehub Project",
      "created": "2022-07-26T19:11:05Z",
      "administrative_contact": {
        "name": "Jane Doe",
        "email": "someone@example.com",
        "role": "Admin",
        "organization": "Blues"
      },
      "technical_contact": {
        "name": "John Doe",
        "email": "someone@example.com",
        "role": "Tech",
        "organization": "Blues"
      },
      "role": "owner"
    }
  ]
}

Get Project by Product

Get information about a Notehub project by ProductUID.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

productUID

string

The ProductUID of a Notehub product.

curl -X GET
    -L 'https://api.notefile.net/v1/products/<productUID>/project'
    -H 'Authorization: Bearer <access_token>'
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub.

technical_contact

object

Contact information for the technical contact assigned in Notehub.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": {
    "name": "John Doe",
    "email": "someone@example.com",
    "role": "Admin",
    "organization": "Blues"
  },
  "technical_contact": {
    "name": "Jane Doe",
    "email": "someone@example.com",
    "role": "Tech",
    "organization": "Blues"
  },
  "role": "owner"
}

Get Project Members

Get all members from a Notehub project.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

curl -X GET
    -L 'https://api.notefile.net/v1/projects/<projectUID>/members'
    -H 'Authorization: Bearer <access_token>'
Response Members

name

string

The name of the project member.

email

string

The email address of the project member (only provided if the auth token provider is an owner of the project).

role

string

The role of the project member (e.g. viewer, developer, or owner).

Example Response
{
  "members": [
    {
      "name": "Jane Doe",
      "email": "someone@blues.com",
      "role": "owner"
    },
    {
      "name": "John Doe",
      "email": "someone@blues.com",
      "role": "developer"
    }
  ]
}

Create Project

Create a new Notehub project.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

label

string

The label of the Notehub project.

billing_account_uid

string

The globally-unique identifier of the billing account. The caller of the API must be able to create projects within the specified billing account, otherwise an error will be returned. This identifier is available with a call to Get Billing Accounts.

curl -X POST
    -L 'https://api.notefile.net/v1/projects'
    -H 'Authorization: Bearer <access_token>'
    -d '{"label":"<label>"}'
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub. Will be null on newly-created projects.

technical_contact

object

Contact information for the technical contact assigned in Notehub. Will be null on newly-created projects.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": null,
  "technical_contact": null,
  "role": "owner"
}

Set Global JSONata Transform

Set the global JSONata transform for a Notehub project.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

jsonata

string

The JSONata expression to be applied to all events of the Notehub project.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/global-transformation'
    -H 'Authorization: Bearer <access_token>'
    -d '<jsonata>'
Response Members
None: an empty object {} means success.

Enable Global JSONata Transform

Enables the global JSONata transform for a Notehub project.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/global-transformation/enable'
    -H 'Authorization: Bearer <access_token>'
Response Members
None: an empty object {} means success.

Disable Global JSONata Transform

Disables the global JSONata transform for a Notehub project.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/global-transformation/disable'
    -H 'Authorization: Bearer <access_token>'
Response Members
None: an empty object {} means success.

Clone Project

Clone a Notehub project.

Minimum Notehub project-level role required:

Arguments

access_token

string

A Notehub API bearer token.

projectUID

string

The ProjectUID of a Notehub project.

label

string

The user-assigned label for the project.

billing_account_uid

string

The globally-unique identifier of the billing account. The caller of the API must be able to create projects within the specified billing account, otherwise an error will be returned. This identifier is available with a call to Get Billing Accounts.

disable_clone_routes

boolean

Whether to disallow the cloning of the routes from the parent project. Default is false if not specified.

disable_clone_fleets

boolean

Whether to disallow the cloning of the fleets from the parent project. Default is false if not specified.

curl -X POST
    -L 'https://api.notefile.net/v1/projects/<projectUID>/clone'
    -H 'Authorization: Bearer <access_token>'
    -d '{"label":"<label>",
         "billing_account_uid":"<billing_account_uid>",
         "disable_clone_routes":<disable_clone_routes>,
         "disable_clone_fleets":<disable_clone_fleets>}'
Response Members

uid

string

The globally-unique identifier of the project.

label

string

The user-assigned label for the project.

created

string

The date and time the project was created in Notehub.

administrative_contact

object

Contact information for the administrative contact assigned in Notehub. Will be null on newly-created projects.

technical_contact

object

Contact information for the technical contact assigned in Notehub. Will be null on newly-created projects.

role

string

The role of the project member creating the API request.

Example Response
{
  "uid": "app:00000000-0000-0000-0000-000000000000",
  "label": "My Cloned Notehub Project",
  "created": "2021-04-26T19:11:05Z",
  "administrative_contact": null,
  "technical_contact": null,
  "role": "owner"
}