Sharing

Download schema

Delete cache

DELETE

https://dev.api.radarbov.app

/api/shares/delete-cache

Bearer (JWT)

Delete cache › Responses

No Content

No data returned

Search

POST

https://dev.api.radarbov.app

/api/shares/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Sharing Partial Data[] · required

PaginationMeta · required

POST/api/shares/search

curl https://dev.api.radarbov.app/api/shares/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "data": [
    {
      "bl_deactivated_manually": true,
      "id": "00000000-0000-0000-0000-000000000000",
      "int_accesses_count": 0,
      "lst_access_types": {},
      "str_description": "str_description",
      "str_name": "str_name",
      "str_status": "str_status",
      "ts_created_at": "2024-08-25T15:00:00Z",
      "ts_expires_at": "2024-08-25T15:00:00Z",
      "ts_scheduled_to": "2024-08-25T15:00:00Z",
      "ts_updated_at": "2024-08-25T15:00:00Z"
    }
  ],
  "meta": {
    "int_current_page": 0,
    "int_max_results": 0,
    "int_total_pages": 0,
    "int_total_results": 0
  }
}

json

application/json

Create

POST

https://dev.api.radarbov.app

/api/shares

Bearer (JWT)

Create › Request Body

Sharing Create

bl_deactivated_manually

boolean

lst_org_ids

string[]

lst_user_ids

string[]

str_description

string

str_name

string

ts_expires_at

string · date-time

ts_scheduled_to

string · date-time

Create › Responses

Created

Sharing · required

POST/api/shares

curl https://dev.api.radarbov.app/api/shares \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_deactivated_manually": true,
  "lst_org_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "lst_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "str_description": "str_description",
  "str_name": "str_name",
  "ts_expires_at": "2024-08-25T15:00:00Z",
  "ts_scheduled_to": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "bl_deactivated_manually": true,
  "lst_org_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "lst_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "str_description": "str_description",
  "str_name": "str_name",
  "ts_expires_at": "2024-08-25T15:00:00Z",
  "ts_scheduled_to": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "accesses": {},
    "bl_deactivated_manually": true,
    "id": "00000000-0000-0000-0000-000000000000",
    "organizations": {},
    "str_description": "str_description",
    "str_name": "str_name",
    "str_status": "str_status",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_scheduled_to": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "users": {}
  }
}

json

application/json

Show

GET

https://dev.api.radarbov.app

/api/shares/{id}

Bearer (JWT)

Show › path Parameters

id

string · required

Show › Responses

Sharing · required

Update

PUT

https://dev.api.radarbov.app

/api/shares/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Sharing Update

bl_deactivated_manually

boolean

lst_org_ids

string[]

lst_user_ids

string[]

str_description

string

str_name

string

ts_expires_at

string · date-time

ts_scheduled_to

string · date-time

Update › Responses

Sharing · required

PUT/api/shares/{id}

curl https://dev.api.radarbov.app/api/shares/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_deactivated_manually": true,
  "lst_org_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "lst_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "str_description": "str_description",
  "str_name": "str_name",
  "ts_expires_at": "2024-08-25T15:00:00Z",
  "ts_scheduled_to": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "bl_deactivated_manually": true,
  "lst_org_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "lst_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "str_description": "str_description",
  "str_name": "str_name",
  "ts_expires_at": "2024-08-25T15:00:00Z",
  "ts_scheduled_to": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "accesses": {},
    "bl_deactivated_manually": true,
    "id": "00000000-0000-0000-0000-000000000000",
    "organizations": {},
    "str_description": "str_description",
    "str_name": "str_name",
    "str_status": "str_status",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_scheduled_to": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "users": {}
  }
}

json

application/json

Update

PATCH

https://dev.api.radarbov.app

/api/shares/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Sharing Update

bl_deactivated_manually

boolean

lst_org_ids

string[]

lst_user_ids

string[]

str_description

string

str_name

string

ts_expires_at

string · date-time

ts_scheduled_to

string · date-time

Update › Responses

Sharing · required

PATCH/api/shares/{id}

curl https://dev.api.radarbov.app/api/shares/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "bl_deactivated_manually": true,
  "lst_org_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "lst_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "str_description": "str_description",
  "str_name": "str_name",
  "ts_expires_at": "2024-08-25T15:00:00Z",
  "ts_scheduled_to": "2024-08-25T15:00:00Z"
}'

Example Request Body

{
  "bl_deactivated_manually": true,
  "lst_org_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "lst_user_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "str_description": "str_description",
  "str_name": "str_name",
  "ts_expires_at": "2024-08-25T15:00:00Z",
  "ts_scheduled_to": "2024-08-25T15:00:00Z"
}

json

Example Responses

{
  "data": {
    "accesses": {},
    "bl_deactivated_manually": true,
    "id": "00000000-0000-0000-0000-000000000000",
    "organizations": {},
    "str_description": "str_description",
    "str_name": "str_name",
    "str_status": "str_status",
    "ts_created_at": "2024-08-25T15:00:00Z",
    "ts_expires_at": "2024-08-25T15:00:00Z",
    "ts_scheduled_to": "2024-08-25T15:00:00Z",
    "ts_updated_at": "2024-08-25T15:00:00Z",
    "users": {}
  }
}

json

application/json

Privacy And Terms Tag

POST

https://dev.api.radarbov.app

/api/shares/search

Bearer (JWT)

Search › query Parameters

int_current_page

integer

Default: 1

int_max_results

integer

Default: 50

Search › Request Body optional

Search › Responses

Sharing Partial Data[] · required

PaginationMeta · required

Create

POST

https://dev.api.radarbov.app

/api/shares

Bearer (JWT)

Create › Request Body

Sharing Create

bl_deactivated_manually

boolean

lst_org_ids

string[]

lst_user_ids

string[]

str_description

string

str_name

string

ts_expires_at

string · date-time

ts_scheduled_to

string · date-time

Create › Responses

Created

Sharing · required

Update

PUT

https://dev.api.radarbov.app

/api/shares/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Sharing Update

bl_deactivated_manually

boolean

lst_org_ids

string[]

lst_user_ids

string[]

str_description

string

str_name

string

ts_expires_at

string · date-time

ts_scheduled_to

string · date-time

Update › Responses

Sharing · required

Update

PATCH

https://dev.api.radarbov.app

/api/shares/{id}

Bearer (JWT)

Update › path Parameters

id

string · required

Update › Request Body

Sharing Update

bl_deactivated_manually

boolean

lst_org_ids

string[]

lst_user_ids

string[]

str_description

string

str_name

string

ts_expires_at

string · date-time

ts_scheduled_to

string · date-time

Update › Responses

Sharing · required