GoSmarter API Gateway

Optimisation

Endpointhttps://api.gosmarter.ai

List optimisation results

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim

Retrieves a list of all optimisation request triggers and results for a company

List optimisation results › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

List optimisation results › Responses

List of optimisation results retrieved successfully

object[]

optimisationRequestTriggerId

string · uuid

companyId

string · uuid

status

integer · int32

triggerCreatedAt

string · date-time

triggerUpdatedAt

string · date-time

resultId

string · uuid

description

string

resultCreatedAt

string · date-time

resultUpdatedAt

string · date-time

resultCount

integer · int32

GET/api/company/{companyId}/optimisation-slim

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim

shell

Example Responses

[
  {
    "optimisationRequestTriggerId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": 0,
    "triggerCreatedAt": "2024-08-25T15:00:00Z",
    "triggerUpdatedAt": "2024-08-25T15:00:00Z",
    "resultId": "00000000-0000-0000-0000-000000000000",
    "description": "description",
    "resultCreatedAt": "2024-08-25T15:00:00Z",
    "resultUpdatedAt": "2024-08-25T15:00:00Z",
    "resultCount": 0
  }
]

json

application/json

Delete optimisation results

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim

Deletes one or more optimisation results for a company

Delete optimisation results › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

Delete optimisation results › Request Body

string[]

Delete optimisation results › Responses

Optimisation results deleted successfully

DELETE/api/company/{companyId}/optimisation-slim

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim \
  --header 'Content-Type: application/json' \
  --data '
[
  "00000000-0000-0000-0000-000000000000"
]
'

shell

Example Request Body

[
  "00000000-0000-0000-0000-000000000000"
]

json

Example Responses

{}

json

application/json

Download optimisation result

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim/{resultId}/download

Downloads an optimisation result. Returns JSON (application/json) when format=json, or ZIP archive with CSV files (application/zip) when format=csv. Default format is JSON.

Download optimisation result › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

resultId

string · uuid · required

The unique identifier of the optimisation result. Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Download optimisation result › query Parameters

format

string

Download format: 'json' (default, returns application/json) or 'csv' (returns application/zip with CSV files)

Download optimisation result › Responses

Success - content type varies based on format parameter (application/json for JSON format, application/zip for CSV format)

dateCreated

string · date-time

dateUpdated

string · date-time

result

string

resultComparison

string

description

string

resultId

string · uuid

companyId

string · uuid

GET/api/company/{companyId}/optimisation-slim/{resultId}/download

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim/:resultId/download

shell

Example Responses

{
  "dateCreated": "2024-08-25T15:00:00Z",
  "dateUpdated": "2024-08-25T15:00:00Z",
  "result": "result",
  "resultComparison": "resultComparison",
  "description": "description",
  "resultId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Get optimisation result

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim/{resultId}

Retrieves detailed information about a specific optimisation result

Get optimisation result › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

resultId

string · uuid · required

The unique identifier of the optimisation result. Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Get optimisation result › Responses

Optimisation result retrieved successfully

dateCreated

string · date-time

dateUpdated

string · date-time

result

string

resultComparison

string

description

string

resultId

string · uuid

companyId

string · uuid

GET/api/company/{companyId}/optimisation-slim/{resultId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim/:resultId

shell

Example Responses

{
  "dateCreated": "2024-08-25T15:00:00Z",
  "dateUpdated": "2024-08-25T15:00:00Z",
  "result": "result",
  "resultComparison": "resultComparison",
  "description": "description",
  "resultId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Start optimisation

POST

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim/start

Starts a new optimisation process for a company

Start optimisation › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

Start optimisation › Request Body

optimisationRequestTriggerId

string · uuid

companyId

string · uuid

Start optimisation › Responses

Optimisation started successfully

POST/api/company/{companyId}/optimisation-slim/start

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "optimisationRequestTriggerId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "optimisationRequestTriggerId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{}

json

application/json

Orders Mill Certification

GoSmarter API Gateway

Optimisation

Endpointhttps://api.gosmarter.ai

List optimisation results

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim

Retrieves a list of all optimisation request triggers and results for a company

List optimisation results › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

List optimisation results › Responses

List of optimisation results retrieved successfully

object[]

optimisationRequestTriggerId

string · uuid

companyId

string · uuid

status

integer · int32

triggerCreatedAt

string · date-time

triggerUpdatedAt

string · date-time

resultId

string · uuid

description

string

resultCreatedAt

string · date-time

resultUpdatedAt

string · date-time

resultCount

integer · int32

GET/api/company/{companyId}/optimisation-slim

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim

shell

Example Responses

[
  {
    "optimisationRequestTriggerId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": 0,
    "triggerCreatedAt": "2024-08-25T15:00:00Z",
    "triggerUpdatedAt": "2024-08-25T15:00:00Z",
    "resultId": "00000000-0000-0000-0000-000000000000",
    "description": "description",
    "resultCreatedAt": "2024-08-25T15:00:00Z",
    "resultUpdatedAt": "2024-08-25T15:00:00Z",
    "resultCount": 0
  }
]

json

application/json

Delete optimisation results

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim

Deletes one or more optimisation results for a company

Delete optimisation results › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

Delete optimisation results › Request Body

string[]

Delete optimisation results › Responses

Optimisation results deleted successfully

DELETE/api/company/{companyId}/optimisation-slim

curl --request DELETE \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim \
  --header 'Content-Type: application/json' \
  --data '
[
  "00000000-0000-0000-0000-000000000000"
]
'

shell

Example Request Body

[
  "00000000-0000-0000-0000-000000000000"
]

json

Example Responses

{}

json

application/json

Download optimisation result

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim/{resultId}/download

Downloads an optimisation result. Returns JSON (application/json) when format=json, or ZIP archive with CSV files (application/zip) when format=csv. Default format is JSON.

Download optimisation result › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

resultId

string · uuid · required

The unique identifier of the optimisation result. Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Download optimisation result › query Parameters

format

string

Download format: 'json' (default, returns application/json) or 'csv' (returns application/zip with CSV files)

Download optimisation result › Responses

Success - content type varies based on format parameter (application/json for JSON format, application/zip for CSV format)

dateCreated

string · date-time

dateUpdated

string · date-time

result

string

resultComparison

string

description

string

resultId

string · uuid

companyId

string · uuid

GET/api/company/{companyId}/optimisation-slim/{resultId}/download

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim/:resultId/download

shell

Example Responses

{
  "dateCreated": "2024-08-25T15:00:00Z",
  "dateUpdated": "2024-08-25T15:00:00Z",
  "result": "result",
  "resultComparison": "resultComparison",
  "description": "description",
  "resultId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Get optimisation result

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim/{resultId}

Retrieves detailed information about a specific optimisation result

Get optimisation result › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

resultId

string · uuid · required

The unique identifier of the optimisation result. Example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Get optimisation result › Responses

Optimisation result retrieved successfully

dateCreated

string · date-time

dateUpdated

string · date-time

result

string

resultComparison

string

description

string

resultId

string · uuid

companyId

string · uuid

GET/api/company/{companyId}/optimisation-slim/{resultId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim/:resultId

shell

Example Responses

{
  "dateCreated": "2024-08-25T15:00:00Z",
  "dateUpdated": "2024-08-25T15:00:00Z",
  "result": "result",
  "resultComparison": "resultComparison",
  "description": "description",
  "resultId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Start optimisation

POST

https://api.gosmarter.ai

/api/company/{companyId}/optimisation-slim/start

Starts a new optimisation process for a company

Start optimisation › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

Start optimisation › Request Body

optimisationRequestTriggerId

string · uuid

companyId

string · uuid

Start optimisation › Responses

Optimisation started successfully

POST/api/company/{companyId}/optimisation-slim/start

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/optimisation-slim/start \
  --header 'Content-Type: application/json' \
  --data '
{
  "optimisationRequestTriggerId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "optimisationRequestTriggerId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{}

json

application/json

Orders Mill Certification