MillCertTagRules

List all mill cert tag rules

GET

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules

Retrieves all mill cert tag rules for the specified company, including linked tag information.

List all mill cert tag rules › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List all mill cert tag rules › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List all mill cert tag rules › Responses

List of mill cert tag rules

metaMillCertTagRuleDto[]

metaMillCertTagRuleDto

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

active

boolean

Whether the rule exists (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this rule

isSystemRule

boolean

True for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted

GET/api/company/{companyId}/millcert-tag-rules

curl https://api.gosmarter.ai/api/company/:companyId/millcert-tag-rules \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tagName": "tagName",
    "tagColor": "tagColor",
    "ruleId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": "description",
    "ruleJson": "ruleJson",
    "isActive": true,
    "active": true,
    "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
    "isSystemRule": true
  }
]

json

application/json

Create new mill cert tag rule

POST

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules

Creates a new mill cert tag rule for the specified company. The rule will be automatically evaluated against existing mill certs. Returns 409 Conflict if a soft-deleted rule with the same name already exists.

Create new mill cert tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Create new mill cert tag rule › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Create new mill cert tag rule › Request Body

createMillCertTagRuleDto

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

Create new mill cert tag rule › Responses

Rule created successfully

millCertTagRuleDto

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

active

boolean

Whether the rule exists (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this rule

isSystemRule

boolean

True for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted

POST/api/company/{companyId}/millcert-tag-rules

curl https://api.gosmarter.ai/api/company/:companyId/millcert-tag-rules \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}'

Example Request Body

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

Example Responses

{
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true,
  "active": true,
  "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
  "isSystemRule": true
}

json

application/json

Get mill cert tag rule

GET

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules/{ruleId}

Retrieves a specific mill cert tag rule by ID with linked tag information.

Get mill cert tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Get mill cert tag rule › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get mill cert tag rule › Responses

The mill cert tag rule

metaMillCertTagRuleDto

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

active

boolean

Whether the rule exists (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this rule

isSystemRule

boolean

True for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted

GET/api/company/{companyId}/millcert-tag-rules/{ruleId}

curl https://api.gosmarter.ai/api/company/:companyId/millcert-tag-rules/:ruleId \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "tagName": "tagName",
  "tagColor": "tagColor",
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true,
  "active": true,
  "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
  "isSystemRule": true
}

json

application/json

Update mill cert tag rule

PUT

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules/{ruleId}

Updates an existing mill cert tag rule. The rule will be re-evaluated against all mill certs.

Update mill cert tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Update mill cert tag rule › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update mill cert tag rule › Request Body

createMillCertTagRuleDto

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

Update mill cert tag rule › Responses

Rule updated successfully

millCertTagRuleDto

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

active

boolean

Whether the rule exists (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this rule

isSystemRule

boolean

True for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted

PUT/api/company/{companyId}/millcert-tag-rules/{ruleId}

curl https://api.gosmarter.ai/api/company/:companyId/millcert-tag-rules/:ruleId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}'

Example Request Body

{
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true
}

json

Example Responses

{
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "tagId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "description": "description",
  "ruleJson": "ruleJson",
  "isActive": true,
  "active": true,
  "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
  "isSystemRule": true
}

json

application/json

Soft-delete mill cert tag rule

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules/{ruleId}

Soft-deletes a mill cert tag rule. The rule is marked inactive and hidden from the rules list.

Soft-delete mill cert tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Soft-delete mill cert tag rule › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Soft-delete mill cert tag rule › Responses

Rule soft-deleted successfully

No data returned

Get mill cert tag rule change history

GET

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules/{ruleId}/history

Returns the full temporal audit history for a mill cert tag rule, most recent changes first.

Get mill cert tag rule change history › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule

Get mill cert tag rule change history › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get mill cert tag rule change history › Responses

Audit history returned successfully

auditEventDto[]

auditEventDto

changedAt

string · date-time

changedById

string · uuid

changedByName

string

changeType

string

auditFieldChange[]

entityType

string

entityLabel

string

List deleted mill cert tag rules

GET

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules/deleted

Retrieves all soft-deleted mill cert tag rules for the specified company.

List deleted mill cert tag rules › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List deleted mill cert tag rules › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List deleted mill cert tag rules › Responses

List of soft-deleted mill cert tag rules

metaMillCertTagRuleDto[]

metaMillCertTagRuleDto

createdAt

string · date-time

Timestamp when the rule was created (UTC)

updatedAt

string · date-time

Timestamp when the rule was last updated (UTC)

tagName

string

Name of the linked tag

tagColor

string

Color of the linked tag

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

active

boolean

Whether the rule exists (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this rule

isSystemRule

boolean

True for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted

GET/api/company/{companyId}/millcert-tag-rules/deleted

curl https://api.gosmarter.ai/api/company/:companyId/millcert-tag-rules/deleted \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "tagName": "tagName",
    "tagColor": "tagColor",
    "ruleId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "tagId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "description": "description",
    "ruleJson": "ruleJson",
    "isActive": true,
    "active": true,
    "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
    "isSystemRule": true
  }
]

json

application/json

Restore soft-deleted mill cert tag rule

POST

https://api.gosmarter.ai

/api/company/{companyId}/millcert-tag-rules/{ruleId}/restore

Restores a soft-deleted mill cert tag rule and triggers re-evaluation of mill cert tagging so that matching mill certs regain the rule-assigned tag.

Restore soft-deleted mill cert tag rule › path Parameters

companyId

string · uuid · required

The unique identifier of the company

ruleId

string · uuid · required

The unique identifier of the rule to restore

Restore soft-deleted mill cert tag rule › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Restore soft-deleted mill cert tag rule › Responses

Rule restored successfully

millCertTagRuleDto

ruleId

string · uuid

Unique identifier for the rule

companyId

string · uuid

Identifier of the owning company

tagId

string · uuid

Tag to assign when rule matches

name

string

Rule name (must be unique within company)

description

string

Optional description

ruleJson

string

JSON representation of the rule logic

isActive

boolean

Whether the rule is active and should be evaluated

active

boolean

Whether the rule exists (false = soft-deleted)

lastModifiedBy

string · uuid

ID of the user who last modified this rule

isSystemRule

boolean

True for rules provisioned by a subscribed Rule Pack — read-only (cannot be edited), but can be deleted

MillCertTags ScrapLog