Jump to

• Request
• Response

Update a production resource

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resources/{resourcesUniqID}

Request

Path Parameters

• PlanId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• resourcesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, ResourceId and WorkCenterId ---for the Resources resource and used to uniquely identify an instance of Resources. The client should not generate the hash key value. Instead, the client should query on the Resources collection resource with a filter on the primary key values in order to navigate to a specific instance of Resources.
  
  For example: resources?q=PlanId=<value1>;ResourceId=<value2>;WorkCenterId=<value3>

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplyIdealSequenceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then apply user-defined ideal sequence to a resource. If false, then don't apply user-defined ideal sequence to a resource. This attribute doesn't have a default value.
• AvailabilityCalendarId: integer (int64)
  Value that uniquely identifies the available calendar.
• availabilityLevels: array Availability Levels
  Title: Availability Levels

  The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.
• CapacityType(required): string
  Maximum Length: 30

  Type of resource capacity. Valid values include single capacity, multiple capacity, or batch.
• ChangeoverCalculation: string
  Maximum Length: 12

  Value that indicates whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence. This attribute applies only to equipment resources. Valid values include Concurrent and Sequential.
• ChangeoverPosition: string
  Maximum Length: 12

  Value that indicates whether changeovers will be considered as setup or cleanup activities. This attribute applies only to equipment resources. Valid values include Setup and Cleanup.
• ConstraintMode(required): string
  Maximum Length: 30

  Mode of constraint. Valid values include RelaxCapacity, Relaxed, and Constrained.
• EnforceHorizonStartFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the horizon start will be enforced during schedule generation. If N, then the horizon start won't be enforced during schedule generation. This attribute doesn't have a default value.
• FixedTimeFenceDuration: number
  Duration of the fixed time fence from the start of the horizon.
• FixedTimeFenceUnit: string
  Maximum Length: 12

  Time unit of measure for the fixed time fence. Valid values include seconds, minutes, hours, and days.
• MaximumCapacity(required): number
  Maximum capacity for multiple capacity resources.
• PlanId(required): integer (int64)
  Value that uniquely identifies the production schedule.
• PrebuildMaximum: number
  Prebuild maximum considered by the dynamic resource allocation solver method.
• PrebuildMaximumFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then use the prebuild maximum. If false, then don't use prebuild maximum. This attribute doesn't have a default value.
• PrebuildMaximumUnit: string
  Maximum Length: 12

  Time unit of measure for the prebuild maximum. Valid values include seconds, minutes, hours, and days.
• RankIndependentAttrCycleFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then continue ideal sequence independent of rank. If false, then don't continue ideal sequence independent of rank. This attribute doesn't have a default value.
• ResourceCode(required): string
  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId(required): integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• ResourceName: string
  Maximum Length: 120

  Name of the resource.
• ResourceType(required): string
  Maximum Length: 30

  Type of production resource. Valid values include Equipment or Labor.
• RestartSequenceAtCycleBoundaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the user-defined ideal attribute sequence will be restarted at each scheduling cycle boundary during schedule generation. If N, then the user-defined ideal attribute sequence won't be restarted. This attribute doesn't have a default value.
• usageLevels: array Usage Levels
  Title: Usage Levels

  The Usage Levels resource manages the usage levels for a production resource.
• WorkCenterCode(required): string
  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId(required): integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.
• WorkCenterName: string
  Maximum Length: 120

  Name of the work center that's associated with the resource.

{
    "required":[
        "CapacityType",
        "ConstraintMode",
        "MaximumCapacity",
        "PlanId",
        "ResourceCode",
        "ResourceId",
        "ResourceType",
        "WorkCenterCode",
        "WorkCenterId"
    ],
    "type":"object",
    "properties":{
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":true
        },
        "PrebuildMaximum":{
            "type":"number",
            "description":"Prebuild maximum considered by the dynamic resource allocation solver method.",
            "nullable":true
        },
        "ChangeoverCalculation":{
            "maxLength":"12",
            "type":"string",
            "description":"Value that indicates whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence. This attribute applies only to equipment resources. Valid values include Concurrent and Sequential.",
            "nullable":true
        },
        "RestartSequenceAtCycleBoundaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the user-defined ideal attribute sequence will be restarted at each scheduling cycle boundary during schedule generation. If N, then the user-defined ideal attribute sequence won't be restarted. This attribute doesn't have a default value.",
            "nullable":true
        },
        "CapacityType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of resource capacity. Valid values include single capacity, multiple capacity, or batch.",
            "nullable":false
        },
        "availabilityLevels":{
            "title":"Availability Levels",
            "type":"array",
            "description":"The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-resources-availabilityLevels-item-patch-request"
            }
        },
        "ChangeoverPosition":{
            "maxLength":"12",
            "type":"string",
            "description":"Value that indicates whether changeovers will be considered as setup or cleanup activities. This attribute applies only to equipment resources. Valid values include Setup and Cleanup.",
            "nullable":true
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false
        },
        "ResourceCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false
        },
        "WorkCenterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center that's associated with the resource.",
            "nullable":true
        },
        "usageLevels":{
            "title":"Usage Levels",
            "type":"array",
            "description":"The Usage Levels resource manages the usage levels for a production resource.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-resources-usageLevels-item-patch-request"
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrebuildMaximumUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the prebuild maximum. Valid values include seconds, minutes, hours, and days.",
            "nullable":true
        },
        "MaximumCapacity":{
            "type":"number",
            "description":"Maximum capacity for multiple capacity resources.",
            "nullable":false
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of production resource. Valid values include Equipment or Labor.",
            "nullable":false
        },
        "ConstraintMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mode of constraint. Valid values include RelaxCapacity, Relaxed, and Constrained.",
            "nullable":false
        },
        "ApplyIdealSequenceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then apply user-defined ideal sequence to a resource. If false, then don't apply user-defined ideal sequence to a resource. This attribute doesn't have a default value.",
            "nullable":true
        },
        "FixedTimeFenceUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the fixed time fence. Valid values include seconds, minutes, hours, and days.",
            "nullable":true
        },
        "FixedTimeFenceDuration":{
            "type":"number",
            "description":"Duration of the fixed time fence from the start of the horizon.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AvailabilityCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the available calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PrebuildMaximumFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then use the prebuild maximum. If false, then don't use prebuild maximum. This attribute doesn't have a default value.",
            "nullable":true
        },
        "EnforceHorizonStartFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the horizon start will be enforced during schedule generation. If N, then the horizon start won't be enforced during schedule generation. This attribute doesn't have a default value.",
            "nullable":true
        },
        "RankIndependentAttrCycleFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then continue ideal sequence independent of rank. If false, then don't continue ideal sequence independent of rank. This attribute doesn't have a default value.",
            "nullable":true
        }
    }
}

Nested Schema : Availability Levels

Type: array

Title: Availability Levels

The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.

Show Source

• Array of: object productionSchedulingPlans-resources-availabilityLevels-item-patch-request

{
    "title":"Availability Levels",
    "type":"array",
    "description":"The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-resources-availabilityLevels-item-patch-request"
    }
}

Nested Schema : Usage Levels

Type: array

Title: Usage Levels

The Usage Levels resource manages the usage levels for a production resource.

Show Source

• Array of: object schema

{
    "title":"Usage Levels",
    "type":"array",
    "description":"The Usage Levels resource manages the usage levels for a production resource.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-resources-usageLevels-item-patch-request"
    }
}

Nested Schema : productionSchedulingPlans-resources-availabilityLevels-item-patch-request

Type: object

Show Source

• Capacity: integer
  Number of resource units that indicates the capacity of a resource.
• EffectiveDate: string (date-time)
  Date when the resource availability level begins.
• LastUpdateDate: string (date-time)
  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Maximum Length: 32

  Login that the user used when updating the document.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Capacity":{
            "type":"integer",
            "description":"Number of resource units that indicates the capacity of a resource.",
            "nullable":false
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the resource availability level begins.",
            "format":"date-time",
            "nullable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Capacity: integer
  Number of resource units that indicates the capacity of a resource.
• EndDate: string (date-time)
  Date when the resource usage level is no longer effective.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• StartDate: string (date-time)
  Date when the resource usage level is effective.
• UsageLevel: integer (int64)
  Level of resource usage.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "type":"string",
            "description":"Date when the resource usage level is effective.",
            "format":"date-time",
            "nullable":false
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Capacity":{
            "type":"integer",
            "description":"Number of resource units that indicates the capacity of a resource.",
            "nullable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the resource usage level is no longer effective.",
            "format":"date-time",
            "nullable":true
        },
        "UsageLevel":{
            "type":"integer",
            "description":"Level of resource usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productionSchedulingPlans-resources-item-response

Type: object

Show Source

• ApplyIdealSequenceFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then apply user-defined ideal sequence to a resource. If false, then don't apply user-defined ideal sequence to a resource. This attribute doesn't have a default value.
• AvailabilityCalendarCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the availability calendar.
• AvailabilityCalendarId: integer (int64)
  Value that uniquely identifies the available calendar.
• availabilityLevels: array Availability Levels
  Title: Availability Levels

  The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.
• CapacityType: string
  Maximum Length: 30

  Type of resource capacity. Valid values include single capacity, multiple capacity, or batch.
• ChangeoverCalculation: string
  Maximum Length: 12

  Value that indicates whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence. This attribute applies only to equipment resources. Valid values include Concurrent and Sequential.
• ChangeoverPosition: string
  Maximum Length: 12

  Value that indicates whether changeovers will be considered as setup or cleanup activities. This attribute applies only to equipment resources. Valid values include Setup and Cleanup.
• ConstraintMode: string
  Maximum Length: 30

  Mode of constraint. Valid values include RelaxCapacity, Relaxed, and Constrained.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• EnforceHorizonStartFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the horizon start will be enforced during schedule generation. If N, then the horizon start won't be enforced during schedule generation. This attribute doesn't have a default value.
• FixedTimeFenceDuration: number
  Duration of the fixed time fence from the start of the horizon.
• FixedTimeFenceUnit: string
  Maximum Length: 12

  Time unit of measure for the fixed time fence. Valid values include seconds, minutes, hours, and days.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumCapacity: number
  Maximum capacity for multiple capacity resources.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• PrebuildMaximum: number
  Prebuild maximum considered by the dynamic resource allocation solver method.
• PrebuildMaximumFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then use the prebuild maximum. If false, then don't use prebuild maximum. This attribute doesn't have a default value.
• PrebuildMaximumUnit: string
  Maximum Length: 12

  Time unit of measure for the prebuild maximum. Valid values include seconds, minutes, hours, and days.
• RankIndependentAttrCycleFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then continue ideal sequence independent of rank. If false, then don't continue ideal sequence independent of rank. This attribute doesn't have a default value.
• ResourceCode: string
  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• ResourceName: string
  Maximum Length: 120

  Name of the resource.
• ResourceType: string
  Maximum Length: 30

  Type of production resource. Valid values include Equipment or Labor.
• RestartSequenceAtCycleBoundaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the user-defined ideal attribute sequence will be restarted at each scheduling cycle boundary during schedule generation. If N, then the user-defined ideal attribute sequence won't be restarted. This attribute doesn't have a default value.
• usageLevels: array Usage Levels
  Title: Usage Levels

  The Usage Levels resource manages the usage levels for a production resource.
• WorkCenterCode: string
  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.
• WorkCenterName: string
  Maximum Length: 120

  Name of the work center that's associated with the resource.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "PrebuildMaximum":{
            "type":"number",
            "description":"Prebuild maximum considered by the dynamic resource allocation solver method.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeoverCalculation":{
            "maxLength":"12",
            "type":"string",
            "description":"Value that indicates whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence. This attribute applies only to equipment resources. Valid values include Concurrent and Sequential.",
            "nullable":true,
            "x-queryable":true
        },
        "RestartSequenceAtCycleBoundaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the user-defined ideal attribute sequence will be restarted at each scheduling cycle boundary during schedule generation. If N, then the user-defined ideal attribute sequence won't be restarted. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "CapacityType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of resource capacity. Valid values include single capacity, multiple capacity, or batch.",
            "nullable":false,
            "x-queryable":true
        },
        "availabilityLevels":{
            "title":"Availability Levels",
            "type":"array",
            "description":"The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-resources-availabilityLevels-item-response"
            }
        },
        "ChangeoverPosition":{
            "maxLength":"12",
            "type":"string",
            "description":"Value that indicates whether changeovers will be considered as setup or cleanup activities. This attribute applies only to equipment resources. Valid values include Setup and Cleanup.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "x-queryable":true
        },
        "AvailabilityCalendarCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the availability calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center that's associated with the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "usageLevels":{
            "title":"Usage Levels",
            "type":"array",
            "description":"The Usage Levels resource manages the usage levels for a production resource.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingPlans-resources-usageLevels-item-response"
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrebuildMaximumUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the prebuild maximum. Valid values include seconds, minutes, hours, and days.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumCapacity":{
            "type":"number",
            "description":"Maximum capacity for multiple capacity resources.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of production resource. Valid values include Equipment or Labor.",
            "nullable":false,
            "x-queryable":true
        },
        "ConstraintMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mode of constraint. Valid values include RelaxCapacity, Relaxed, and Constrained.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyIdealSequenceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then apply user-defined ideal sequence to a resource. If false, then don't apply user-defined ideal sequence to a resource. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedTimeFenceUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the fixed time fence. Valid values include seconds, minutes, hours, and days.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedTimeFenceDuration":{
            "type":"number",
            "description":"Duration of the fixed time fence from the start of the horizon.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AvailabilityCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the available calendar.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrebuildMaximumFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then use the prebuild maximum. If false, then don't use prebuild maximum. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "EnforceHorizonStartFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the horizon start will be enforced during schedule generation. If N, then the horizon start won't be enforced during schedule generation. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "RankIndependentAttrCycleFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then continue ideal sequence independent of rank. If false, then don't continue ideal sequence independent of rank. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Availability Levels

Type: array

Title: Availability Levels

The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.

Show Source

• Array of: object productionSchedulingPlans-resources-availabilityLevels-item-response

{
    "title":"Availability Levels",
    "type":"array",
    "description":"The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-resources-availabilityLevels-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Usage Levels

Type: array

Title: Usage Levels

The Usage Levels resource manages the usage levels for a production resource.

Show Source

• Array of: object productionSchedulingPlans-resources-usageLevels-item-response

{
    "title":"Usage Levels",
    "type":"array",
    "description":"The Usage Levels resource manages the usage levels for a production resource.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingPlans-resources-usageLevels-item-response"
    }
}

Nested Schema : productionSchedulingPlans-resources-availabilityLevels-item-response

Type: object

Show Source

• Capacity: integer
  Number of resource units that indicates the capacity of a resource.
• CreatedBy: string
  Maximum Length: 64

  Date and time when the user created the record.
• CreationDate: string (date-time)
  Date when the resource usage level is no longer effective.
• EffectiveDate: string (date-time)
  Date when the resource availability level begins.
• LastUpdateDate: string (date-time)
  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Maximum Length: 32

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the resource usage level is no longer effective.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date and time when the user created the record.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Capacity":{
            "type":"integer",
            "description":"Number of resource units that indicates the capacity of a resource.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the resource availability level begins.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : productionSchedulingPlans-resources-usageLevels-item-response

Type: object

Show Source

• Capacity: integer
  Number of resource units that indicates the capacity of a resource.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• EndDate: string (date-time)
  Date when the resource usage level is no longer effective.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• ResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• StartDate: string (date-time)
  Date when the resource usage level is effective.
• UsageLevel: integer (int64)
  Level of resource usage.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center. It's a primary key of the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the resource usage level is no longer effective.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UsageLevel":{
            "type":"integer",
            "description":"Level of resource usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the resource usage level is effective.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Capacity":{
            "type":"integer",
            "description":"Number of resource units that indicates the capacity of a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

applyAvailabilityLevelPattern

Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resources/{resourcesUniqID}/action/applyAvailabilityLevelPattern

Parameters:

• PlanId: $request.path.PlanId
• resourcesUniqID: $request.path.resourcesUniqID

Request changing an availability level to run scenarios when changing the number of resource units available.

availabilityLevels

Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resources/{resourcesUniqID}/child/availabilityLevels

Parameters:

• PlanId: $request.path.PlanId
• resourcesUniqID: $request.path.resourcesUniqID

The level of resource units available for the work center resource. This can occur if you have varying resource unit levels by shift such as 10 in the day shift and 8 in the night shift or during holidays where 0 resource units are available.

usageLevels

Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/resources/{resourcesUniqID}/child/usageLevels

Parameters:

• PlanId: $request.path.PlanId
• resourcesUniqID: $request.path.resourcesUniqID

The Usage Levels resource manages the usage levels for a production resource.

Back to Top