Actions

Suggest

Changed on

Returns the ranked insertion options for a single unassigned job.

Exactly one job in jobs may be left unassigned - that is the job being suggested. Every other job must carry initialResource (and normally initialArrival) to describe the schedule the new job is inserted into. Alternatively, one whole job relation may be unassigned, in which case every job named by that relation is left without initialResource. Any other combination is rejected.

Note that initialArrival is a sequencing hint, not a pin: the solver re-times already assigned jobs as early as the shift allows. Use windows on a job to hold a committed time.

post/v2/vrp/suggest

Request

  • Base URL
    https://api.solvice.io
  • URL
    https://api.solvice.io/v2/vrp/suggest
  • Auth
    API key in header Authorization

Query parameters

millisstring nullable required

Request body

hookstring uri nullable

Optional webhook URL that will receive a POST request with the job ID when the optimization is complete. This enables asynchronous processing where you can submit a request and be notified when results are ready, rather than waiting for the synchronous response.

labelstring nullable
metadataobject nullable

Example request

{
  "jobs": [
    {
      "name": "1",
      "duration": 3600,
      "initialResource": "1",
      "initialArrival": "2023-01-13T09:00:00"
    },
    {
      "name": "2",
      "duration": 3600
    }
  ],
  "resources": [
    {
      "name": "1",
      "shifts": [
        {
          "from": "2023-01-13T08:00:00",
          "to": "2023-01-13T17:00:00"
        }
      ]
    }
  ]
}

Response

Status

idstring required

Job ID

status'QUEUED' | 'SOLVING' | 'SOLVED' | 'ERROR' nullable

Status of the solve.

solveDurationinteger nullable

Duration of the solve in seconds

Example response

{
  "status": "SOLVING"
}

Changes

  • d015cfede38eRevision changes
    • breaking

      the query request parameter millis became required

    • breaking

      added the pattern ^(?!.*\$\{)[^<>"';\\\x00]*$ to the request property jobs/items/initialResource

    • breaking

      added the pattern ^(?!.*\$\{)[^<>"';\\\x00]*$ to the request property jobs/items/plannedResource

    • breaking

      added the pattern ^(?!.*\$\{)[^<>"';\\\x00]*$ to the request property jobs/items/proficiency/items/resource

    • breaking

      added the pattern ^(?!.*\$\{)[^<>"';\\\x00]*$ to the request property relations/items/resource

    • warning

      the // request property's maxLength was set to 255

    • warning

      the // request property's maxLength was set to 255

    • warning

      the //// request property's maxLength was set to 255

    • warning

      the // request property's maxLength was set to 255

    • warning

      changed the pattern of the request property // from ^(?!.*\$\{)[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\\x00]*$

    • warning

      changed the pattern of the request property //// from ^(?!.*\$\{)[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\\x00]*$

    • warning

      changed the pattern of the request property //// from ^(?!.*\$\{)[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\\x00]*$

    • warning

      changed the pattern of the request property // from ^(?!.*\$\{)[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\\x00]*$

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      added the new optional request property /////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property /////

    • info

      added the new optional request property //

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      the request property // became optional

    • info

      added the new DUTY enum value to the request property //////

    • info

      added the new TOMTOM_REAL_TIME enum value to the request property /////////

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

  • d77ac8b3d302Revision changes
    • warning

      the // request property's min was set to 0.00

    • warning

      changed the pattern of the request property // from ^[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\]*$

    • warning

      changed the pattern of the request property //// from ^[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\]*$

    • warning

      changed the pattern of the request property //// from ^[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\]*$

    • warning

      changed the pattern of the request property // from ^[^<>"';\\]*$ to ^(?!.*\$\{)[^<>"';\\]*$