Jump to

• Request
• Response

Create operation resources

post

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/workOrderOperations/{workOrderOperationsUniqID}/child/operationResources

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=
• workOrderOperationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, WorkOrderOperationId and ResourceSequenceNumber ---for the Work Order Operations resource and used to uniquely identify an instance of Work Order Operations. The client should not generate the hash key value. Instead, the client should query on the Work Order Operations collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Order Operations.
  
  For example: workOrderOperations?q=PlanId=<value1>;WorkOrderOperationId=<value2>;ResourceSequenceNumber=<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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowOffloading: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value.
• CapacityRequired: number
  Number of alternate resource instances. Valid values include Labor or Equipment.
• Duration: number
  Duration of the resource for an operation.
• DurationUnit: string
  Maximum Length: 30

  Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days.
• ExpendedDuration: number
  Duration of the expended resource on the operation.
• LotMultiple: number
  Lot multiple of the operation resource.
• OriginalCapacityRequired: number
  Capacity required for the original planned resource.
• OriginalResourceId: integer (int64)
  Value that uniquely identifies the original resource.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• PrincipalFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value.
• RemainingDuration: number
  Duration that's remaining.
• ResourceActivityName: string
  Maximum Length: 80

  Name of the resource activity.
• ResourceId: integer (int64)
  Value that uniquely identifies the production resource. It's a primary key of the resource.
• ResourceSequenceNumber: number
  Number that identifies the resource sequence of the operation resource.
• ScheduledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center. It's a primary key of the work center.
• WorkDefinitionOperationResourceId: integer (int64)
  Value that uniquely identifies the work definition operation resource.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
• WorkOrderOperationResourceId: integer (int64)
  Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.

{
    "type":"object",
    "properties":{
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key of the work order operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "WorkDefinitionOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"Number that identifies the resource sequence of the operation resource.",
            "nullable":false
        },
        "Duration":{
            "type":"number",
            "description":"Duration of the resource for an operation.",
            "nullable":false
        },
        "OriginalResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ScheduledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value.",
            "nullable":true
        },
        "RemainingDuration":{
            "type":"number",
            "description":"Duration that's remaining.",
            "nullable":true
        },
        "AllowOffloading":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value.",
            "nullable":true
        },
        "OriginalCapacityRequired":{
            "type":"number",
            "description":"Capacity required for the original planned resource.",
            "nullable":true
        },
        "CapacityRequired":{
            "type":"number",
            "description":"Number of alternate resource instances. Valid values include Labor or Equipment.",
            "nullable":true
        },
        "ExpendedDuration":{
            "type":"number",
            "description":"Duration of the expended resource on the operation.",
            "nullable":true
        },
        "LotMultiple":{
            "type":"number",
            "description":"Lot multiple of the operation resource.",
            "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
            }
        },
        "PrincipalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value.",
            "nullable":true
        },
        "DurationUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days.",
            "nullable":true
        },
        "WorkOrderOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceActivityName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource activity.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-workOrderOperations-operationResources-item-response

Type: object

Show Source

• AllowOffloading: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value.
• CapacityRequired: number
  Number of alternate resource instances. Valid values include Labor or Equipment.
• 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.
• Duration: number
  Duration of the resource for an operation.
• DurationUnit: string
  Maximum Length: 30

  Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days.
• ExpendedDuration: number
  Duration of the expended resource on the operation.
• 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.
• LotMultiple: number
  Lot multiple of the operation resource.
• OriginalCapacityRequired: number
  Capacity required for the original planned resource.
• OriginalResourceCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the original resource.
• OriginalResourceId: integer (int64)
  Value that uniquely identifies the original resource.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• PrincipalFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value.
• RemainingDuration: number
  Duration that's remaining.
• ResourceActivityName: string
  Maximum Length: 80

  Name of the resource activity.
• 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.
• ResourceSequenceNumber: number
  Number that identifies the resource sequence of the operation resource.
• ScheduledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value.
• 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.
• WorkDefinitionOperationResourceId: integer (int64)
  Value that uniquely identifies the work definition operation resource.
• WorkOrderOperationId: integer (int64)
  Value that uniquely identifies the work order operation. It's a primary key of the work order operation.
• WorkOrderOperationResourceId: integer (int64)
  Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "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
        },
        "ScheduledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then scheduling schedules the resource and computes the start date and completion dates. If No, then scheduling doesn't schedule the resource, and it sets the start date equal to the completion date. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "RemainingDuration":{
            "type":"number",
            "description":"Duration that's remaining.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalCapacityRequired":{
            "type":"number",
            "description":"Capacity required for the original planned resource.",
            "nullable":true,
            "x-queryable":true
        },
        "CapacityRequired":{
            "type":"number",
            "description":"Number of alternate resource instances. Valid values include Labor or Equipment.",
            "nullable":true,
            "x-queryable":true
        },
        "PrincipalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the resource is the principal resource among the group of simultaneous resources. If false, then the resource isn't the principal resource. This attribute doesn't have a default value.",
            "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
        },
        "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
        },
        "WorkOrderOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation. It's a primary key of the work order operation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work definition operation resource.",
            "format":"int64",
            "nullable":true,
            "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
        },
        "ResourceSequenceNumber":{
            "type":"number",
            "description":"Number that identifies the resource sequence of the operation resource.",
            "nullable":false,
            "x-queryable":true
        },
        "OriginalResourceCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the original resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Duration":{
            "type":"number",
            "description":"Duration of the resource for an operation.",
            "nullable":false,
            "x-queryable":true
        },
        "OriginalResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the original resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllowOffloading":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then allow offloading of the production resource to a viable alternate. If false, then don't allow offloading of the production resource to a viable alternate. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpendedDuration":{
            "type":"number",
            "description":"Duration of the expended resource on the operation.",
            "nullable":true,
            "x-queryable":true
        },
        "LotMultiple":{
            "type":"number",
            "description":"Lot multiple of the operation resource.",
            "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
        },
        "DurationUnit":{
            "maxLength":30,
            "type":"string",
            "description":"Time unit of measure for the duration. Valid values include seconds, minutes, hours, and days.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation resource. It's a primary key of the work order operation resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceActivityName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource activity.",
            "nullable":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"
    }
}

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."
        }
    }
}

Back to Top