OptimisationFilterProfiles

createOptimisationFilterProfileRequest

createdBy

string · uuid

lastModifiedBy

string · uuid

createdAt

string · date-time

updatedAt

string · date-time

GET/api/company/{companyId}/optimisation/filter-profiles

curl https://api.gosmarter.ai/api/company/:companyId/optimisation/filter-profiles \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "profileId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "filters": {
      "inventory": {
        "typeIds": [
          0
        ],
        "materialIds": [
          0
        ],
        "stockLocationIds": [
          0
        ],
        "supplierIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "minDiameterMm": 0,
        "maxDiameterMm": 0
      },
      "orders": {
        "statuses": [
          "string"
        ],
        "deliveryFrom": "2024-08-25T15:00:00Z",
        "deliveryTo": "2024-08-25T15:00:00Z",
        "orderReferences": [
          "string"
        ],
        "tagIds": [
          "00000000-0000-0000-0000-000000000000"
        ]
      }
    },
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0
    },
    "solverSettings": {
      "algorithm": "algorithm",
      "populationSize": 0,
      "maxIterations": 0,
      "timeLimitSeconds": 0,
      "offcutThresholdMm": {
        "default": 0,
        "byDiameterMaxMm": [
          {
            "maxDiameterMm": 0,
            "thresholdMm": 0
          }
        ]
      },
      "kerfMm": 0,
      "priorities": {
        "orderUrgency": "orderUrgency",
        "stockConsumption": "stockConsumption",
        "wasteVsSimplicity": 0,
        "certQuality": 0
      }
    },
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Save a new optimisation filter profile

POST

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/filter-profiles

Save a new optimisation filter profile › path Parameters

companyId

string · uuid · required

Save a new optimisation filter profile › 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.

Save a new optimisation filter profile › Request Body

name

string

optimisationFilterProfileDto

Save a new optimisation filter profile › Responses

Payload of OptimisationFilterProfileDto

profileId

string · uuid

companyId

string · uuid

name

string

createOptimisationFilterProfileRequest

createdBy

string · uuid

lastModifiedBy

string · uuid

createdAt

string · date-time

updatedAt

string · date-time

POST/api/company/{companyId}/optimisation/filter-profiles

curl https://api.gosmarter.ai/api/company/:companyId/optimisation/filter-profiles \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "priorities": {
    "orderUrgency": "orderUrgency",
    "stockConsumption": "stockConsumption",
    "wasteVsSimplicity": 0,
    "certQuality": 0
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0
    }
  }
}'

Example Request Body

{
  "name": "name",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "priorities": {
    "orderUrgency": "orderUrgency",
    "stockConsumption": "stockConsumption",
    "wasteVsSimplicity": 0,
    "certQuality": 0
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0
    }
  }
}

json

Example Responses

{
  "profileId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "priorities": {
    "orderUrgency": "orderUrgency",
    "stockConsumption": "stockConsumption",
    "wasteVsSimplicity": 0,
    "certQuality": 0
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0
    }
  },
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "lastModifiedBy": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Update a saved optimisation filter profile

PUT

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/filter-profiles/{profileId}

Update a saved optimisation filter profile › path Parameters

companyId

string · uuid · required

profileId

string · uuid · required

Update a saved optimisation filter profile › 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 a saved optimisation filter profile › Request Body

name

string

optimisationFilterProfileDto

Update a saved optimisation filter profile › Responses

Payload of OptimisationFilterProfileDto

profileId

string · uuid

companyId

string · uuid

name

string