GoSmarter API Gateway

ScrapLog

Endpointhttps://api.gosmarter.ai

List all scrap log entries

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Retrieves all scrap log entries for the specified company, filtered by active status, ordered by log date descending.

List all scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all scrap log entries › query Parameters

active

boolean

Filter by active status (true = active items, false = deleted items). Defaults to true.

List all scrap log entries › Responses

List of scrap log entries retrieved successfully

object[]

loggedByName

string

Display name of the user who logged this entry

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

GET/api/company/{companyId}/scrap-log

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log

shell

Example Responses

[
  {
    "loggedByName": "loggedByName",
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "netWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "active": true
  }
]

json

application/json

Update existing scrap log entries

PUT

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Updates one or more existing scrap log entries. Each entry must belong to the specified company. All changes are recorded in the edit history for audit purposes.

Update existing scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Update existing scrap log entries › Request Body

object[]

scrapLogId

string · uuid

logDate

string · date-time

binSkipReference

string

startingWeight

number · double

closingWeight

number · double

Update existing scrap log entries › Responses

Scrap log entries updated successfully

object[]

loggedByName

string

Display name of the user who logged this entry

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

PUT/api/company/{companyId}/scrap-log

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0
  }
]
'

shell

Example Request Body

[
  {
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0
  }
]

json

Example Responses

[
  {
    "loggedByName": "loggedByName",
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "netWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "active": true
  }
]

json

application/json

Create new scrap log entries

POST

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Creates one or more new scrap log entries for the specified company. Each entry will be associated with the companyId provided in the route and the current authenticated user.

Create new scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new scrap log entries › Request Body

object[]

logDate

string · date-time

binSkipReference

string

startingWeight

number · double

closingWeight

number · double

loggedBy

string · uuid

Create new scrap log entries › Responses

Scrap log entries created successfully

object[]

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

POST/api/company/{companyId}/scrap-log

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000"
  }
]
'

shell

Example Request Body

[
  {
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000"
  }
]

json

Example Responses

[
  {
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "netWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "active": true
  }
]

json

application/json

Delete scrap log entries

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Deletes one or more scrap log entries for the specified company using a stored procedure that enforces authorization and ownership.

Delete scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company owning the entries

Delete scrap log entries › Request Body

string[]

Delete scrap log entries › Responses

Scrap log entries deleted successfully

deletedItems

string[]

List of deleted scrap log entry IDs

DELETE/api/company/{companyId}/scrap-log

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

shell

Example Request Body

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

json

Example Responses

{
  "deletedItems": [
    "string"
  ]
}

json

application/json

Download scrap log as CSV

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/download

Downloads all scrap log entries for a company as a CSV file

Download scrap log as CSV › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Download scrap log as CSV › query Parameters

active

boolean

Filter by active status (true = active items, false = deleted items). Defaults to true.

Download scrap log as CSV › Responses

CSV file with scrap log data

string · binary

GET/api/company/{companyId}/scrap-log/download

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/download

shell

Example Responses

string

csv

text/csv

Get a scrap log entry by ID

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/{scrapLogId}

Retrieves a single scrap log entry by its unique ID within the specified company.

Get a scrap log entry by ID › path Parameters

companyId

string · uuid · required

The unique identifier of the company that owns the scrap log entry

scrapLogId

string · uuid · required

The unique identifier of the scrap log entry to retrieve

Get a scrap log entry by ID › Responses

Scrap log entry retrieved successfully

loggedByName

string

Display name of the user who logged this entry

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

GET/api/company/{companyId}/scrap-log/{scrapLogId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/:scrapLogId

shell

Example Responses

{
  "loggedByName": "loggedByName",
  "scrapLogId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "logDate": "2024-08-25T15:00:00Z",
  "binSkipReference": "binSkipReference",
  "startingWeight": 0,
  "closingWeight": 0,
  "netWeight": 0,
  "loggedBy": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "active": true
}

json

application/json

Get edit history for a scrap log entry

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/{scrapLogId}/history

Retrieves the complete audit trail of all changes made to a specific scrap log entry, ordered by edit timestamp descending.

Get edit history for a scrap log entry › path Parameters

companyId

string · uuid · required

The unique identifier of the company

scrapLogId

string · uuid · required

The unique identifier of the scrap log entry

Get edit history for a scrap log entry › Responses

Edit history retrieved successfully

object[]

scrapLogEditHistoryId

integer · int32

Unique identifier for the edit history entry

scrapLogId

string · uuid

The scrap log entry that was edited

editor

string · uuid

User ID of the editor

editorName

string

Display name of the editor

fieldChanged

string

Name of the field that was changed

oldValue

string

Previous value before the edit

newValue

string

New value after the edit

editedAt

string · date-time

Timestamp when the edit occurred (UTC)

GET/api/company/{companyId}/scrap-log/{scrapLogId}/history

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/:scrapLogId/history

shell

Example Responses

[
  {
    "scrapLogEditHistoryId": 0,
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "editor": "00000000-0000-0000-0000-000000000000",
    "editorName": "editorName",
    "fieldChanged": "fieldChanged",
    "oldValue": "oldValue",
    "newValue": "newValue",
    "editedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Restore deleted scrap log entries

POST

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/restore

Restores one or more soft-deleted scrap log entries for the specified company by setting Active = 1.

Restore deleted scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company owning the entries

Restore deleted scrap log entries › Request Body

string[]

Restore deleted scrap log entries › Responses

Scrap log entries restored successfully

deletedItems

string[]

List of deleted scrap log entry IDs

POST/api/company/{companyId}/scrap-log/restore

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/restore \
  --header 'Content-Type: application/json' \
  --data '
[
  "00000000-0000-0000-0000-000000000000"
]
'

shell

Example Request Body

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

json

Example Responses

{
  "deletedItems": [
    "string"
  ]
}

json

application/json

Upload scrap log from CSV

POST

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/upload

Uploads and processes a CSV file to create scrap log entries in bulk

Upload scrap log from CSV › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Upload scrap log from CSV › Request Body

Upload scrap log from CSV › Responses

CSV uploaded and processed successfully

POST/api/company/{companyId}/scrap-log/upload

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/upload \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Example Request Body

{}

json

Example Responses

{}

json

application/json

Get CSV upload template

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/upload-template

Downloads a CSV template file with example scrap log data for bulk uploads

Get CSV upload template › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get CSV upload template › Responses

CSV template file with examples

string · binary

GET/api/company/{companyId}/scrap-log/upload-template

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/upload-template

shell

Example Responses

string

csv

text/csv

User Reference Data

GoSmarter API Gateway

ScrapLog

Endpointhttps://api.gosmarter.ai

List all scrap log entries

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Retrieves all scrap log entries for the specified company, filtered by active status, ordered by log date descending.

List all scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all scrap log entries › query Parameters

active

boolean

Filter by active status (true = active items, false = deleted items). Defaults to true.

List all scrap log entries › Responses

List of scrap log entries retrieved successfully

object[]

loggedByName

string

Display name of the user who logged this entry

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

GET/api/company/{companyId}/scrap-log

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log

shell

Example Responses

[
  {
    "loggedByName": "loggedByName",
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "netWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "active": true
  }
]

json

application/json

Update existing scrap log entries

PUT

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Updates one or more existing scrap log entries. Each entry must belong to the specified company. All changes are recorded in the edit history for audit purposes.

Update existing scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Update existing scrap log entries › Request Body

object[]

scrapLogId

string · uuid

logDate

string · date-time

binSkipReference

string

startingWeight

number · double

closingWeight

number · double

Update existing scrap log entries › Responses

Scrap log entries updated successfully

object[]

loggedByName

string

Display name of the user who logged this entry

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

PUT/api/company/{companyId}/scrap-log

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0
  }
]
'

shell

Example Request Body

[
  {
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0
  }
]

json

Example Responses

[
  {
    "loggedByName": "loggedByName",
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "netWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "active": true
  }
]

json

application/json

Create new scrap log entries

POST

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Creates one or more new scrap log entries for the specified company. Each entry will be associated with the companyId provided in the route and the current authenticated user.

Create new scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new scrap log entries › Request Body

object[]

logDate

string · date-time

binSkipReference

string

startingWeight

number · double

closingWeight

number · double

loggedBy

string · uuid

Create new scrap log entries › Responses

Scrap log entries created successfully

object[]

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

POST/api/company/{companyId}/scrap-log

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000"
  }
]
'

shell

Example Request Body

[
  {
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000"
  }
]

json

Example Responses

[
  {
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "logDate": "2024-08-25T15:00:00Z",
    "binSkipReference": "binSkipReference",
    "startingWeight": 0,
    "closingWeight": 0,
    "netWeight": 0,
    "loggedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "active": true
  }
]

json

application/json

Delete scrap log entries

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log

Deletes one or more scrap log entries for the specified company using a stored procedure that enforces authorization and ownership.

Delete scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company owning the entries

Delete scrap log entries › Request Body

string[]

Delete scrap log entries › Responses

Scrap log entries deleted successfully

deletedItems

string[]

List of deleted scrap log entry IDs

DELETE/api/company/{companyId}/scrap-log

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

shell

Example Request Body

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

json

Example Responses

{
  "deletedItems": [
    "string"
  ]
}

json

application/json

Download scrap log as CSV

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/download

Downloads all scrap log entries for a company as a CSV file

Download scrap log as CSV › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Download scrap log as CSV › query Parameters

active

boolean

Filter by active status (true = active items, false = deleted items). Defaults to true.

Download scrap log as CSV › Responses

CSV file with scrap log data

string · binary

GET/api/company/{companyId}/scrap-log/download

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/download

shell

Example Responses

string

csv

text/csv

Get a scrap log entry by ID

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/{scrapLogId}

Retrieves a single scrap log entry by its unique ID within the specified company.

Get a scrap log entry by ID › path Parameters

companyId

string · uuid · required

The unique identifier of the company that owns the scrap log entry

scrapLogId

string · uuid · required

The unique identifier of the scrap log entry to retrieve

Get a scrap log entry by ID › Responses

Scrap log entry retrieved successfully

loggedByName

string

Display name of the user who logged this entry

scrapLogId

string · uuid

Unique identifier for the scrap log entry

companyId

string · uuid

Identifier of the owning company

logDate

string · date-time

Date when the scrap was logged

binSkipReference

string

Bin or skip reference identifier

startingWeight

number · double

Starting weight in kilograms

closingWeight

number · double

Closing weight in kilograms

netWeight

number · double

Net weight (calculated as ClosingWeight - StartingWeight) in kilograms

loggedBy

string · uuid

User ID of the person who logged this entry

createdAt

string · date-time

Timestamp when the record was created (UTC)

updatedAt

string · date-time

Timestamp when the record was last updated (UTC)

active

boolean

Soft delete flag (true = active, false = deleted)

GET/api/company/{companyId}/scrap-log/{scrapLogId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/:scrapLogId

shell

Example Responses

{
  "loggedByName": "loggedByName",
  "scrapLogId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "logDate": "2024-08-25T15:00:00Z",
  "binSkipReference": "binSkipReference",
  "startingWeight": 0,
  "closingWeight": 0,
  "netWeight": 0,
  "loggedBy": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "active": true
}

json

application/json

Get edit history for a scrap log entry

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/{scrapLogId}/history

Retrieves the complete audit trail of all changes made to a specific scrap log entry, ordered by edit timestamp descending.

Get edit history for a scrap log entry › path Parameters

companyId

string · uuid · required

The unique identifier of the company

scrapLogId

string · uuid · required

The unique identifier of the scrap log entry

Get edit history for a scrap log entry › Responses

Edit history retrieved successfully

object[]

scrapLogEditHistoryId

integer · int32

Unique identifier for the edit history entry

scrapLogId

string · uuid

The scrap log entry that was edited

editor

string · uuid

User ID of the editor

editorName

string

Display name of the editor

fieldChanged

string

Name of the field that was changed

oldValue

string

Previous value before the edit

newValue

string

New value after the edit

editedAt

string · date-time

Timestamp when the edit occurred (UTC)

GET/api/company/{companyId}/scrap-log/{scrapLogId}/history

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/:scrapLogId/history

shell

Example Responses

[
  {
    "scrapLogEditHistoryId": 0,
    "scrapLogId": "00000000-0000-0000-0000-000000000000",
    "editor": "00000000-0000-0000-0000-000000000000",
    "editorName": "editorName",
    "fieldChanged": "fieldChanged",
    "oldValue": "oldValue",
    "newValue": "newValue",
    "editedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Restore deleted scrap log entries

POST

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/restore

Restores one or more soft-deleted scrap log entries for the specified company by setting Active = 1.

Restore deleted scrap log entries › path Parameters

companyId

string · uuid · required

The unique identifier of the company owning the entries

Restore deleted scrap log entries › Request Body

string[]

Restore deleted scrap log entries › Responses

Scrap log entries restored successfully

deletedItems

string[]

List of deleted scrap log entry IDs

POST/api/company/{companyId}/scrap-log/restore

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/restore \
  --header 'Content-Type: application/json' \
  --data '
[
  "00000000-0000-0000-0000-000000000000"
]
'

shell

Example Request Body

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

json

Example Responses

{
  "deletedItems": [
    "string"
  ]
}

json

application/json

Upload scrap log from CSV

POST

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/upload

Uploads and processes a CSV file to create scrap log entries in bulk

Upload scrap log from CSV › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Upload scrap log from CSV › Request Body

Upload scrap log from CSV › Responses

CSV uploaded and processed successfully

POST/api/company/{companyId}/scrap-log/upload

curl --request POST \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/upload \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Example Request Body

{}

json

Example Responses

{}

json

application/json

Get CSV upload template

GET

https://api.gosmarter.ai

/api/company/{companyId}/scrap-log/upload-template

Downloads a CSV template file with example scrap log data for bulk uploads

Get CSV upload template › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get CSV upload template › Responses

CSV template file with examples

string · binary

GET/api/company/{companyId}/scrap-log/upload-template

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId/scrap-log/upload-template

shell

Example Responses

string

csv

text/csv

User Reference Data