Brein API

CronHistory

Get all cron history records with pagination

GET

/api/v1/cron-history

Retrieve a paginated list of cron job execution history based on query parameters

Get all cron history records with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
dummystring
Dummy filter

Get all cron history records with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/cron-history

curl --request GET \
  --url /api/v1/cron-history

shell

Show example in

Example Responses

No example

json

application/json

Create a cron history record

POST

/api/v1/cron-history

Create a new cron history record with the provided data

Create a cron history record › Request Body

processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

Create a cron history record › Responses

CronHistory created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

POST /api/v1/cron-history

curl --request POST \
  --url /api/v1/cron-history \
  --header 'Content-Type: application/json' \
  --data '
{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}
'

shell

Show example in

Request Body Example

{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}

json

Example Responses

No example

json

application/json

Get cron history by ID

GET

/api/v1/cron-history/{id}

Retrieve a specific cron history record by its ID

Get cron history by ID › path Parameters

idnumber · min: 1 · required
Id

Get cron history by ID › Responses

CronHistory detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

GET /api/v1/cron-history/{id}

curl --request GET \
  --url /api/v1/cron-history/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a cron history record

PUT

/api/v1/cron-history/{id}

Update an existing cron history record by its ID

Update a cron history record › path Parameters

idnumber · min: 1 · required
Id

Update a cron history record › Request Body

processingTimestring · date-time
Time when the processing started
schoolobject
School being processed
targetDatestring · date-time
Target date for the processed permissions/invitations
statusstring · enum
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

Update a cron history record › Responses

CronHistory updated

No data returned

PUT /api/v1/cron-history/{id}

curl --request PUT \
  --url /api/v1/cron-history/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}
'

shell

Show example in

Request Body Example

{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}

json

Example Responses

No example

plain

Delete a cron history record

DELETE

/api/v1/cron-history/{id}

Delete a cron history record by its ID

Delete a cron history record › path Parameters

idnumber · min: 1 · required
Id

Delete a cron history record › Responses

CronHistory deleted

No data returned

DELETE /api/v1/cron-history/{id}

curl --request DELETE \
  --url /api/v1/cron-history/:id

shell

Show example in

Example Responses

No example

plain

Route Availability Student Lost Article

Brein API

CronHistory

Get all cron history records with pagination

GET

/api/v1/cron-history

Retrieve a paginated list of cron job execution history based on query parameters

Get all cron history records with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
dummystring
Dummy filter

Get all cron history records with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/cron-history

curl --request GET \
  --url /api/v1/cron-history

shell

Show example in

Example Responses

No example

json

application/json

Create a cron history record

POST

/api/v1/cron-history

Create a new cron history record with the provided data

Create a cron history record › Request Body

processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

Create a cron history record › Responses

CronHistory created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

POST /api/v1/cron-history

curl --request POST \
  --url /api/v1/cron-history \
  --header 'Content-Type: application/json' \
  --data '
{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}
'

shell

Show example in

Request Body Example

{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}

json

Example Responses

No example

json

application/json

Get cron history by ID

GET

/api/v1/cron-history/{id}

Retrieve a specific cron history record by its ID

Get cron history by ID › path Parameters

idnumber · min: 1 · required
Id

Get cron history by ID › Responses

CronHistory detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
processingTimestring · date-time · required
Time when the processing started
schoolobject · required
School being processed
targetDatestring · date-time · required
Target date for the processed permissions/invitations
statusstring · enum · required
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

GET /api/v1/cron-history/{id}

curl --request GET \
  --url /api/v1/cron-history/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a cron history record

PUT

/api/v1/cron-history/{id}

Update an existing cron history record by its ID

Update a cron history record › path Parameters

idnumber · min: 1 · required
Id

Update a cron history record › Request Body

processingTimestring · date-time
Time when the processing started
schoolobject
School being processed
targetDatestring · date-time
Target date for the processed permissions/invitations
statusstring · enum
Status of the cron execution
Enum values:
RUNNING
SUCCESS
FAILED

Update a cron history record › Responses

CronHistory updated

No data returned

PUT /api/v1/cron-history/{id}

curl --request PUT \
  --url /api/v1/cron-history/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}
'

shell

Show example in

Request Body Example

{
  "processingTime": "2024-08-25T15:00:00Z",
  "school": {
    "id": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tenantId": "tenant-123",
    "workCenterKey": "0000001",
    "name": "Springfield High School",
    "email": "contact@school.com",
    "phone": "+521148863257",
    "slugImg": "/slug-school/school-123.png",
    "levels": [
      "string"
    ],
    "status": "INITIAL_DATA"
  },
  "targetDate": "2024-08-25T15:00:00Z",
  "status": "RUNNING"
}

json

Example Responses

No example

plain

Delete a cron history record

DELETE

/api/v1/cron-history/{id}

Delete a cron history record by its ID

Delete a cron history record › path Parameters

idnumber · min: 1 · required
Id

Delete a cron history record › Responses

CronHistory deleted

No data returned

DELETE /api/v1/cron-history/{id}

curl --request DELETE \
  --url /api/v1/cron-history/:id

shell

Show example in

Example Responses

No example

plain

Route Availability Student Lost Article