Upsert Production Schedule Resource Setting

Beta

PUT/v1/operations/production-schedule-settings/resources

This endpoint is idempotent. Learn more

Writes a per-resource planning override.

One override exists per resource, so this replaces any existing entry for the same scope rather than adding a second. Machines are selected by the constraint department, so this is where one is taken out of planning — a machine down for a rebuild — and where a department or step declares how many weeks after the constraint its work starts.

Permissions requiredValues:production_schedules:update

The role behind your API key or agent must grant every one of these permissions.

scope_typestringenumValues:machinedepartmentproduction_step

What kind of resource this overrides.

scope_ref_idstring

ID of the machine, department or production step.

participation_statusstringenumValues:includedexcluded

Whether this resource takes part in planning. Machines are selected by department, so this excludes one rather than opting one in.

lead_time_weeksoptional number

Weeks of lead time at this resource.

lead_time_offset_weeksnumber

Weeks after the constraint campaign this resource's work starts.

idstring

Resource setting ID.

objectstringenumValues:production_schedule_resource_setting

Resource type identifier.

scope_typestringenumValues:machinedepartmentproduction_step

What kind of resource this overrides.

scopeentitynullable

The machine, department or production step this overrides.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

participation_statusstringenumValues:includedexcluded

Whether this resource takes part in planning. Machines are selected by department, so this takes one out rather than opting one in — for a machine down for a rebuild that should not be planned against.

lead_time_weeksnumbernullable

Weeks of lead time at this resource.

lead_time_offset_weeksnumber

Weeks after the constraint campaign this resource's work starts.

Responses

200

Successful response for Upsert Production Schedule Resource Setting

Upsert Production Schedule Resource Setting

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const productionScheduleResourceSetting =
  await client.operations.productionScheduleSettings.resources.update({
    lead_time_offset_weeks: 0,
    participation_status: 'excluded',
    scope_ref_id: 'mc_0177d18f55a1615f783d3bf8d0',
    scope_type: 'machine',
  });

console.log(productionScheduleResourceSetting.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const productionScheduleResourceSetting =
  await client.operations.productionScheduleSettings.resources.update({
    lead_time_offset_weeks: 0,
    participation_status: 'excluded',
    scope_ref_id: 'mc_0177d18f55a1615f783d3bf8d0',
    scope_type: 'machine',
  });

console.log(productionScheduleResourceSetting.id);

200 example

{
  "id": "pnscrrsd_0192e8a6bf7c8d2e",
  "object": "production_schedule_resource_setting",
  "scope_type": "machine",
  "scope": {
    "id": "mc_0177d18f55a1615f783d3bf8d0",
    "object": "entity",
    "type": "machine",
    "name": null,
    "handle": null
  },
  "participation_status": "included",
  "lead_time_weeks": null,
  "lead_time_offset_weeks": 0
}

{
  "id": "pnscrrsd_0192e8a6bf7c8d2e",
  "object": "production_schedule_resource_setting",
  "scope_type": "machine",
  "scope": {
    "id": "mc_0177d18f55a1615f783d3bf8d0",
    "object": "entity",
    "type": "machine",
    "name": null,
    "handle": null
  },
  "participation_status": "included",
  "lead_time_weeks": null,
  "lead_time_offset_weeks": 0
}

Upsert Production Schedule Resource Setting

Authorization

Request Body

Returns

Responses