Upsert Production Schedule Resource Setting

Beta

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

This endpoint is idempotent. Learn more

Writes a planning override for one machine, department or production step.

A resource has at most one override, so this replaces the existing entry for the same scope rather than adding a second, and the entry keeps the ID it already had. Machines are chosen by naming the constraint department, so this is where one is taken out of planning — a machine down for a rebuild — and where a production step declares how many weeks its work starts after the step that feeds it.

Overrides are read when a plan is generated, so a change takes effect on the next generated version and leaves existing ones untouched.

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 override applies to.

Together with the resource ID it identifies the override, so writing the same pair again updates the existing entry in place and keeps its ID.

scope_ref_idstring

ID of the machine, department or production step being overridden, matching the scope type.

participation_statusstringenumValues:includedexcluded

Whether this resource takes part in planning.

Machines are chosen by naming the constraint department, so this is how one is taken out — a machine down for a rebuild — rather than how one is opted in.

lead_time_weeksoptional number

Weeks of lead time at this resource.

lead_time_offset_weeksnumber

How many weeks after the step feeding it this resource's work starts.

Read when downstream department work is derived from the constraint plan, so it is the production-step override that shifts a plan: without an offset every step lands in the same week as the step feeding it, and the offsets along a chain of steps add up. A schedule is planned in whole weeks, so a fractional offset is truncated.

idstring

Resource setting ID.

objectstringenumValues:production_schedule_resource_setting

Resource type identifier.

scope_typestringenumValues:machinedepartmentproduction_step

What kind of resource this override applies to.

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 chosen by naming the constraint department, so an override is how one is taken out — a machine down for a rebuild — rather than how one is opted in. A machine with no override is planned.

lead_time_weeksnumbernullable

Weeks of lead time at this resource.

lead_time_offset_weeksnumber

How many weeks after the step feeding it this resource's work starts.

Responses

200

Successful response for Upsert Production Schedule Resource Setting

Upsert Production Schedule Resource Setting

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  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_ffcfk9dxixis',
    scope_type: 'machine',
  });

console.log(productionScheduleResourceSetting.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  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_ffcfk9dxixis',
    scope_type: 'machine',
  });

console.log(productionScheduleResourceSetting.id);

200 example

{
  "id": "pnscrrsd_hegthjeksw87",
  "object": "production_schedule_resource_setting",
  "scope_type": "department",
  "scope": {
    "id": "dp_m0jayebxnkos",
    "object": "entity",
    "type": "department",
    "name": "Fabrication",
    "handle": null
  },
  "participation_status": "included",
  "lead_time_weeks": 0.5,
  "lead_time_offset_weeks": 1
}

{
  "id": "pnscrrsd_hegthjeksw87",
  "object": "production_schedule_resource_setting",
  "scope_type": "department",
  "scope": {
    "id": "dp_m0jayebxnkos",
    "object": "entity",
    "type": "department",
    "name": "Fabrication",
    "handle": null
  },
  "participation_status": "included",
  "lead_time_weeks": 0.5,
  "lead_time_offset_weeks": 1
}

Upsert Production Schedule Resource Setting

Authorization

Request Body

Returns

Responses