Fishbowl
Fishbowl Advanced REST API Documentation

Integrations

These endpoints are used to modify Fishbowl plugin information. In order to access the plugin's information, you will need authorization from the plugin.

ENDPOINTS
GET /api/integrations/plugin-info
POST /api/integrations/plugin-info
POST /api/integrations/plugin-info/:id
DELETE /api/integrations/plugin-info/:id
The plugin information object
Attributes
  • id integer
    The plugin information's unique identification number.
  • plugin string
    The name of the plugin.
  • table string
    The name of the database table.
  • recordId int
    The unique identifier for a record in Fishbowl associated with the table.
  • groupId int
    The user specified identifier used to separate types of plugins you are using.
  • channelId string
    The unique identifier for the object being linked externally.
  • info json
    Any additional information.
THE PLUGIN INFORMATION OBJECT
{
  "id": 32,
  "plugin": "Fishbowl Time",
  "table": "WO",
  "recordId": 72,
  "groupId": 20,
  "channelId": "27d1891e-0627-4abf-87a6-9a38db5d78f2",
  "info": {
    "id": 123
  }
}
Search for plugin information

Searches for plugin information.

Parameters
  • plugin string
    The name of the plugin.
  • authorization string
    The user specified code for authorization.
  • table string optional
    The table name in the database.
  • recordId int optional
    The unique identifier for a record in Fishbowl associated with the table.
  • groupId int optional
    The user specified identifier used to separate types of plugins you are using.
  • channelId string optional
    The unique identifier for the object being linked externally.
Attributes

    No attributes.

GET /api/integrations/plugin-info 
curl --location \
--request GET '<YOUR SERVER>/api/integrations/plugin-info' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
[
  {
    "id": 31,
    "plugin": "Fishbowl Time",
    "table": "WO",
    "recordId": 72,
    "groupId": 10,
    "channelId": "b674f2bf-7ea2-491f-8d70-8cf4fd3243fc"
  },
  {
    "id": 32,
    "plugin": "Fishbowl Time",
    "table": "WO",
    "recordId": 72,
    "groupId": 20,
    "channelId": "27d1891e-0627-4abf-87a6-9a38db5d78f2",
    "info": {
      "id": 123
    }
  }
]
Create a plugin information

Creates a plugin information.

Parameters
  • plugin string
    The name of the plugin.
  • authorization string
    The user specified code for authorization.
Attributes
  • groupId int optional
    The user specified identifier used to separate types of plugins you are using.
  • channelId string optional
    The unique identifier for the object being linked externally.
  • recordId int optional
    The unique identifier for a record in Fishbowl associated with the table.
  • table string optional
    The table name in the database.
POST /api/integrations/plugin-info 
curl --location \
--request POST '<YOUR SERVER>/api/integrations/plugin-info' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<PLUGIN INFO JSON>'
RESPONSE
[
  {
    "id": 31,
    "plugin": "Fishbowl Time",
    "table": "WO",
    "recordId": 72,
    "groupId": 10,
    "channelId": "b674f2bf-7ea2-491f-8d70-8cf4fd3243fc"
  },
  {
    "id": 32,
    "plugin": "Fishbowl Time",
    "table": "WO",
    "recordId": 72,
    "groupId": 20,
    "channelId": "27d1891e-0627-4abf-87a6-9a38db5d78f2",
    "info": {
      "id": 123
    }
  }
]
Update a plugin information

Updates a plugin information.

Parameters
  • plugin string
    The name of the plugin.
  • authorization string
    The user specified code for authorization.
Attributes
  • info json
    The information to be updated.
POST /api/integrations/plugin-info/:id 
curl --location \
--request POST '<YOUR SERVER>/api/integrations/plugin-info/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>' \
--data-raw '<PLUGIN INFO JSON>'
RESPONSE
[
  {
    "id": 31,
    "plugin": "Fishbowl Time",
    "table": "WO",
    "recordId": 72,
    "groupId": 10,
    "channelId": "b674f2bf-7ea2-491f-8d70-8cf4fd3243fc"
  },
  {
    "id": 32,
    "plugin": "Fishbowl Time",
    "table": "WO",
    "recordId": 72,
    "groupId": 20,
    "channelId": "27d1891e-0627-4abf-87a6-9a38db5d78f2",
    "info": {
      "id": 123
    }
  }
]
Delete a plugin information

Deletes the plugin information with the specified ID.

Parameters
  • plugin string
    The name of the plugin.
  • authorization string
    The user specified code for authorization.
Attributes

    No attributes.

DELETE /api/integrations/plugin-info/:id 
curl --location \
--request DELETE '<YOUR SERVER>/api/integrations/plugin-info/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <TOKEN>'
RESPONSE
{}