Channels

Channel and search management

post

Body

application/json

namestringRequired

querystringOptional

filtersstring[]Optional

Responses

200

POST /api/v1/channels/create Positive response

application/json

statusconst: successRequired

400

POST /api/v1/channels/create Negative response

application/json

post/api/v1/channels/create

HTTPcURLJavaScriptPython

POST /api/v1/channels/create HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "name": "text",
  "query": "text",
  "filters": [
    "text"
  ],
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "query": "text",
    "filters": [
      "text"
    ],
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null
  }
}

get

Query parameters

namestringOptional

GET /api/v1/channels/get Parameter

Responses

200

GET /api/v1/channels/get Positive response

application/json

statusconst: successRequired

400

GET /api/v1/channels/get Negative response

application/json

get/api/v1/channels/get

HTTPcURLJavaScriptPython

GET /api/v1/channels/get HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "query": "text",
    "filters": [
      "text"
    ],
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null
  }
}

head

Query parameters

namestringOptional

HEAD /api/v1/channels/get Parameter

Responses

200

HEAD /api/v1/channels/get Positive response

No content

400

HEAD /api/v1/channels/get Negative response

head/api/v1/channels/get

HTTPcURLJavaScriptPython

HEAD /api/v1/channels/get HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content

post

Body

application/json

onConflictstring · enumOptionalDefault: errorPossible values:

Responses

200

POST /api/v1/channels/batch/create Positive response

application/json

statusconst: successRequired

400

POST /api/v1/channels/batch/create Negative response

application/json

post/api/v1/channels/batch/create

HTTPcURLJavaScriptPython

POST /api/v1/channels/batch/create HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "channels": [
    {
      "name": "text",
      "query": "text",
      "filters": [
        "text"
      ],
      "annotations": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "onConflict": "error"
}

{
  "status": "text",
  "data": {
    "results": [
      {
        "name": "text",
        "status": "created",
        "channel": {
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "query": "text",
          "filters": [
            "text"
          ],
          "annotations": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": null,
          "updatedAt": null
        },
        "error": "text"
      }
    ]
  }
}

post

Body

application/json

Responses

200

POST /api/v1/channels/batch/upsert Positive response

application/json

statusconst: successRequired

400

POST /api/v1/channels/batch/upsert Negative response

application/json

post/api/v1/channels/batch/upsert

HTTPcURLJavaScriptPython

POST /api/v1/channels/batch/upsert HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "channels": [
    {
      "query": "text",
      "filters": [
        "text"
      ],
      "annotations": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "name": "text"
    }
  ]
}

{
  "status": "text",
  "data": {
    "results": [
      {
        "name": "text",
        "status": "created",
        "channel": {
          "accountId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "query": "text",
          "filters": [
            "text"
          ],
          "annotations": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": null,
          "updatedAt": null
        },
        "error": "text"
      }
    ]
  }
}

put

Body

application/json

querystringOptional

filtersstring[]Optional

namestringRequired

Responses

200

PUT /api/v1/channels/update Positive response

application/json

statusconst: successRequired

400

PUT /api/v1/channels/update Negative response

application/json

put/api/v1/channels/update

HTTPcURLJavaScriptPython

PUT /api/v1/channels/update HTTP/1.1
Host: rules.app.gomboc.ai
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "query": "text",
  "filters": [
    "text"
  ],
  "annotations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "name": "text"
}

{
  "status": "text",
  "data": {
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "query": "text",
    "filters": [
      "text"
    ],
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": null,
    "updatedAt": null
  }
}

delete

Query parameters

namestringRequired

DELETE /api/v1/channels/delete Parameter

Responses

200

DELETE /api/v1/channels/delete Positive response

application/json

statusconst: successRequired

400

DELETE /api/v1/channels/delete Negative response

application/json

delete/api/v1/channels/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/channels/delete?name=text HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "success": true
  }
}

get

Query parameters

namestringOptional

GET /api/v1/channels/rules Parameter

filtersany ofOptional

GET /api/v1/channels/rules Parameter

stringOptional

or

string[]Optional

filters[]any ofOptional

GET /api/v1/channels/rules Parameter

stringOptional

or

string[]Optional

pagenumberOptional

GET /api/v1/channels/rules Parameter

Default: 1

perPagenumberOptional

GET /api/v1/channels/rules Parameter

Default: 20

includeClassificationsnumberOptional

GET /api/v1/channels/rules Parameter

Default: 1

Responses

200

GET /api/v1/channels/rules Positive response

application/json

statusconst: successRequired

400

GET /api/v1/channels/rules Negative response

application/json

get/api/v1/channels/rules

HTTPcURLJavaScriptPython

GET /api/v1/channels/rules HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "rules": [
      {
        "accountId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "version": "text",
        "iacLanguage": "text",
        "name": "text",
        "shortName": null,
        "revision": 1,
        "revisions": [
          1
        ],
        "classificationPaths": [
          [
            {
              "accountId": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "shortName": null
            }
          ]
        ],
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "body": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": null,
        "updatedAt": null
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 1
  }
}

head

Query parameters

namestringOptional

HEAD /api/v1/channels/rules Parameter

filtersany ofOptional

HEAD /api/v1/channels/rules Parameter

stringOptional

or

string[]Optional

filters[]any ofOptional

HEAD /api/v1/channels/rules Parameter

stringOptional

or

string[]Optional

pagenumberOptional

HEAD /api/v1/channels/rules Parameter

Default: 1

perPagenumberOptional

HEAD /api/v1/channels/rules Parameter

Default: 20

includeClassificationsnumberOptional

HEAD /api/v1/channels/rules Parameter

Default: 1

Responses

200

HEAD /api/v1/channels/rules Positive response

No content

400

HEAD /api/v1/channels/rules Negative response

head/api/v1/channels/rules

HTTPcURLJavaScriptPython

HEAD /api/v1/channels/rules HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content

get

Query parameters

pagenumberOptional

GET /api/v1/channels/search Parameter

Default: 1

perPagenumberOptional

GET /api/v1/channels/search Parameter

Default: 20

querystringOptional

GET /api/v1/channels/search Parameter

Responses

200

GET /api/v1/channels/search Positive response

application/json

statusconst: successRequired

400

GET /api/v1/channels/search Negative response

application/json

get/api/v1/channels/search

HTTPcURLJavaScriptPython

GET /api/v1/channels/search HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

{
  "status": "text",
  "data": {
    "channels": [
      {
        "accountId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "query": "text",
        "filters": [
          "text"
        ],
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": null,
        "updatedAt": null
      }
    ],
    "total": 1,
    "page": 1,
    "perPage": 1
  }
}

head

Query parameters

pagenumberOptional

HEAD /api/v1/channels/search Parameter

Default: 1

perPagenumberOptional

HEAD /api/v1/channels/search Parameter

Default: 20

querystringOptional

HEAD /api/v1/channels/search Parameter

Responses

200

HEAD /api/v1/channels/search Positive response

No content

400

HEAD /api/v1/channels/search Negative response

head/api/v1/channels/search

HTTPcURLJavaScriptPython

HEAD /api/v1/channels/search HTTP/1.1
Host: rules.app.gomboc.ai
Accept: */*

No content