List Production Schedule Resource Settings

Beta

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

This endpoint is idempotent. Learn more

Returns every per-machine, per-department and per-step override of the account's planning assumptions.

An override exists only for a resource that has been given one: this is where a machine is taken out of the plan, and where a production step declares how many weeks its work starts after the step that feeds it. Anything absent from this list is planned on the account settings alone.

The account's full set of overrides is returned at once — there are no filters and nothing to page through.

Permissions requiredValues:production_schedules:read

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of production_schedule_resource_setting

Resources in this page.

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.

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.

Responses

200

Successful response for List Production Schedule Resource Settings

List Production Schedule Resource Settings

import OpenMRP from '@openmrp/sdk';

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

const listProductionScheduleResourceSetting =
  await client.operations.productionScheduleSettings.resources.list();

console.log(listProductionScheduleResourceSetting.data);

import OpenMRP from '@openmrp/sdk';

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

const listProductionScheduleResourceSetting =
  await client.operations.productionScheduleSettings.resources.list();

console.log(listProductionScheduleResourceSetting.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/production-schedule-settings/resources?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicG5zY3Jyc2RfaGVndGhqZWtzdzg3IiwiZCI6ImYifQ.FxQLsHRDnUgJpaLh2FmKbvK3sGjNeJyY7xOGrEkmTxU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/production-schedule-settings/resources?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicG5zY3Jyc2RfaGVndGhqZWtzdzg3IiwiZCI6ImYifQ.FxQLsHRDnUgJpaLh2FmKbvK3sGjNeJyY7xOGrEkmTxU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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
    }
  ]
}

List Production Schedule Resource Settings

Authorization

Returns

Responses