List Production Schedule Resource Settings

Beta

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

This endpoint is idempotent. Learn more

Returns the per-machine, per-department and per-step planning overrides.

This is where machines are marked as the planning constraint, and where a department or step declares how many weeks after the constraint its work starts.

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.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

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 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 List Production Schedule Resource Settings

List Production Schedule Resource Settings

import Augno from '@augno/sdk';

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

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

console.log(listProductionScheduleResourceSetting.data);

import Augno from '@augno/sdk';

const client = new Augno({
  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=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicG5zY3Jyc2RfMDE5MmU4YTZiZjdjOGQyZSIsImQiOiJmIn0.WAFlq9PnBiT4k3R8Tz42THhmqyIEs5EkqNDoHK5D3_o",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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
    }
  ]
}

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

List Production Schedule Resource Settings

Authorization

Returns

Responses