Welcome to the Protogrid Developer Wiki. A place to gather all the documentation and tips&tricks regarding Protogrid.

JSON API Endpoints

This section lists the different API endpoints you can use to access or update Protogrid data. The respective http method is defined as [METHOD] following the endpoint in this documentation.

Response

Every request to such an API endpoint returns a JSON object. The returned JSON object always contains an error and a result object. If the request was successful, the result object contains the requested or updated data. When the request fails, the errors object contains the error messages which occurred when trying to execute the request.

Example successful response

{
  "errors": [], 
  "protogrid_environment_version": "1.3.9",
  "result":{
    "key": {},
    "key": [],
    "key": "data"
  }
}

Example failure response

{
  "errors": [
    {},
    {}
  ], 
  "protogrid_environment_version": "1.3.9",
  "result": {}
}

Field Types

In Protogrid there exist different types of fields such as numbers, text or dates.

Number Field

Text Field

Date Time Field

Protogrid always uses ISO 8601 standard in UTC timezone for storing date time values.

Relation Field

Role Field

End Points

The Protogrid JSON API offers the following API endpoints:

/api/v2/apps

[GET] Returns a list of all Applications to which the authenticated user has access to.

Example request:

https://example.protogrid.com/api/v2/apps

Example response:

{
  "errors": [], 
  "protogrid_environment_version": "1.3.9",
  "result":[
    {
      "app_id": "app_example_id", 
      "description": "Example App", 
      "logo_url": "", 
      "theme_color": "blue-dark", 
      "title": "Example App ", 
      "url": "/example", 
      "url_name": "example"
    },
    {
      "app_id": "appID",
      "description": "Your awesome app",},
    …
  ]
}

/api/v2/apps/<app_name>

[GET] Returns basic information about one Application.

Example request:

https://example.protogrid.com/api/v2/apps/example

Example response:

{ 
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "result": { 
    "app_id": "appID",
    "description": "Example App",
    "logo_url": "",
    "theme_color": "blue-dark",
    "title": "Example App ", 
    "url": "/example",
    "url_name": "example"
  }
}

/api/v2/apps/<app_name>/views

[GET] Returns a list of all view names in this Application. Details on what views are supported, see all available views.

Example request:

https://example.protogrid.com/api/v2/apps/example/views

Example response:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "result": {
    "views": [
      {"view_name": "examples_by_id"},
      {}
    ]
  }
}

/api/v2/apps/<app_name>/views/<view_name>

Most of the API endpoints except you to specify App or Card IDs. At the time at which this data is requested, these ids therefore already need to be known. It is therefore necessary to have convenient ways of asking Protogrid about what ids are available based on different search criteria. Database views can be used to acquire collections of data based on sorting and filtering URL parameters.

[GET] Returns all the entries in the specified view. Please note that URL parameters must be URI encoded. URL Parameter:

  • start_key: [“proto_key”, “column_key”, “filter_value”, null], where column_key and filter_value are optional.
  • end_key: [“proto_key”, “column_key”, “filter_value”, {}], where column_key and filter_value are optional
  • keys: [“key1”, “key2”, “key3”, …], only returns the entries for the specified keys
  • page_number: Set to 1 if on the first page, otherwise 2
  • limit: Accepts a number, which defines how many cards are returned in the result object.
    • Example: limit=15
    • Default value: 10
  • descending: If set to true the results will be in descending order.
    • Example: descending=true
    • Default value: False
  • include_cards: If set to true the result contains the cards for the keys as well.
    • Example: include_cards=true
    • Default value: False

Note: you may only use either keys or start_key and end_key.

Details: For more details about the URL parameters see the CouchDB documentation.

Full list of views can be found here.

Example request:

https://example.protogrid.com/api/v2/apps/example/views/example_view?start_key=["example_proto_key",null]&end_key=["example_proto_key",{}]&page_number=1&limit=2&descending=false

The URL parameters need to be URI encoded. So from the example above the start_key parameter would look like

start_key= %5B%22example_proto_key%22%2Cnull%5D

Example response:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "result": {
    "next_card_key": "key",
    "rows": [
      {"key": "example_document_key", "shortname": "example_shortname"},
      {}
    ]
  }
}

/api/v2/apps/<app_name>/cards

[POST] Creates a new card. It is necessary to specify a proto_key on which the card will be based. If wished, it is possible to send the design_elements along, if the field is undefined, Protogrid uses the design_elements specified in the Proto. Note that obligatory fields need to be set. If a card key is specified, Protogrid will try to find this card and update it with the provided data. If it is not found, an error will be returned.

Added functionality with

  • 1.6.7:
    • If you supply a list of cards, all of them will be created.
    • The return value is now a list of all updated cards.

Example request:

https://example.protogrid.com/api/v2/apps/example/cards

Together with the request, you need to send a JSON object like the following example:

{ 
  "proto_key": "some_proto_key",
  "design_elements":[
  {"definition_key": "example_design_element_key", "value":"example_value"},
  {}
  ]
}

Example response:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "results": {
    "_id": "some_card_id",
    "_rev": "some_rev_id",
    "denormalized": {},
    …
  }
}

Deprecated functionalities:

  • Specification of a user-defined card key (1.6.7): In previous versions, it was possible to specify a card key in the JSON object sent to the JSON API. This functionality is deprecated and will be removed in future releases. As of now, it might lead to unexpected behaviour in agents and other functionalities. If you relied on this feature to insert foreign IDs into Protogrid, we suggest using an auxiliary field containing the foreign id.

/api/v2/apps/<app_name>/cards/<card_key>

[GET] Returns a specific card identified by card_key.

[DELETE] Deletes a specific card identified by card_key logically. The deleted card will be still available, either through the API or the UI using the Trash under Administration. The return value contains the deleted card.

[POST] Updates the card identified by card_key. If the _id field is set in the JSON, it needs to match the card_key. In addition, the proto_key must match those of a proto, otherwise an error is thrown.

Example request:

https://example.protogrid.com/api/v2/apps/example/cards/some_card_id

JSON:

{
  _id: some_card_id,
  proto_key: some_proto_key,
  design_elements:[
    {"definition_key": "example_design_element_key", "value":
     "example_value"},
    {}
  ]
}

Example response:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "results": {
    "_id": "some_card_id",
    "_rev": "some_rev_id",
    "denormalized": {},
    …
  }
}

/api/v2/apps/<app_name>/protos

[GET] Returns a list of all protos of the specified application.

The following URL parameter can be used for paging:

  • card_key: Passing a card_key will give you a result starting from that key
  • limit: Defines how many proto keys are returned. Takes a number between 1 and 1000, default is 10.

The returned result contains a key “next_card_key” whose value is the next key not returned in this answer. Using the parameter “card_key” one can start the next page exactly at the next Proto.

Example request:

https://example.protogrid.com/api/v2/apps/example/protos?card_key=ExampleProtoKey&limit=1

Example result:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "result": {
    next_card_key: "NextProtoKey"
    "protos":[
      {"key": "ExampleProtoKey", "shortname": {"en": "Proto: Example Proto"}}
    ]
  }
}

/api/v2/apps/<app_name>/protos/<proto_key>

[GET] Returns detailed information about the specified Proto.

Example request:

https://example.protogrid.com/api/v2/apps/example/protos/example_proto

Example result:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "result": {
    "key": <proto_key>,
    "shortname": example_proto,
    "field_and_widget_keys": [
      {
        "allow_new_cards": true,
        "cardinality_setting": 2,
        "couchdb_viewname": "",
        "disable_label": false,
        "display_priority": 7,
        "element_type": "Relation",
        "grid_size_setting": 0,
        "help_text": "",
        "hidden": false,
        "label_multilanguage_key": "&&mlkey_design_elements",
        "multiple_values_setting": 1,
        "name": "card_design_elements",
        "parent_application_setting": "",
        "parent_entity_proto_setting": "DesignElementDefinition",
        "requirement_setting": 0,
        "show_card_type": true,
        "show_created_setting": false,
        "show_creator_setting": false,
        "show_modified_setting": false,
        "show_modifier_setting": false,
        "show_short_name_setting": false,
        "show_to_users": 0,
        "user_enabled_setting": 0,
        "value": [
          "design_element_key_1 ",
          "design_element_key_2",],
        "value_type": "key"
      },
      {},
      …
    ]
  }
}

/api/v2/apps/<app_name>/protos/<proto_key>/card-keys

[GET] Returns the keys for all Cards based on the specified proto.

The following URL parameter can be used for paging:

  • card_key: Passing a card_key will give you a result starting from that key
  • limit: Defines how many card keys are returned. Takes a number between 1 and 1000, default is 10.

The returned result contains a key “next_card_key” whose value is the next key not returned in this answer. Using the parameter “card_key” one can start the next page exactly at the next Card.

Example request:

https://example.protogrid.com/api/v2/apps/example/protos/example_proto/card-keys?card_key=ExampleCardKey&limit=1

Example result:

{
  "errors": [],
  "protogrid_environment_version": "1.3.9",
  "result": [
    "card_keys":[
      "ExampleCardKey"
    ],
    "next_card_key": "NextCardKey"
  ]
}
Print/export