Jump to

• Request
• Response

Update one resource

patch

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/Resources/{ResourceId}

Request

Path Parameters

• PlanId(required): integer
  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=
• ResourceId(required): integer
  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=

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

• AvailableAllDayIndicator: integer
  Value that indicates whether the resource is available 24 hours a day or not. Valid values are: 1 or 2. If 1, then resource is available 24 hours a day. If 2, then not.
• AvailableAllDayResource: string
  Maximum Length: 4000

  Value that indicates whether the resource is available 24 hours a day or not. Valid values are: Yes or No. If Yes, then the resource is available 24 hours a day. If No, then the resource isn't available 24 hours a day.
• Bottleneck: string
  Maximum Length: 4000

  Value that indicates whether the resource is a bottleneck resource or not. Valid values are: 1 or 2. If 1, then resource is a bottleneck. If 2, then not.
• BottleneckIndicator: integer
  Value that indicates whether the resource is a bottleneck or not. Valid values are: Yes or No. If Yes, then the resource is a bottleneck. If No, then the resource isn't a bottleneck.
• Critical: integer
  Value that indicates whether the resource is critical to honor resource capacity constraint or not. Valid values are: 1 or 2. If 1, then the resource is critical. If 2, then the resource isn't critical.
• CriticalResource: string
  Maximum Length: 4000

  Value that indicates whether the resource is critical to honor the resource capacity constraint or not. Valid values are: Yes or No. If Yes, then the resource is critical. If No, then the resource isn't critical.
• EfficiencyPercent: number
  Percentage of the actual output compared to the expected standard output.
• PlanId: integer (int64)
  Unique identifier of the plan.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource.
• UtilizationPercent: number
  Percentage of how much a resource is utilized.

{
    "type":"object",
    "properties":{
        "Bottleneck":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates whether the resource is a bottleneck resource or not. Valid values are: 1 or 2. If 1, then resource is a bottleneck. If 2, then not.",
            "nullable":true
        },
        "CriticalResource":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates whether the resource is critical to honor the resource capacity constraint or not. Valid values are: Yes or No. If Yes, then the resource is critical. If No, then the resource isn't critical.",
            "nullable":true
        },
        "BottleneckIndicator":{
            "type":"integer",
            "description":"Value that indicates whether the resource is a bottleneck or not. Valid values are: Yes or No. If Yes, then the resource is a bottleneck. If No, then the resource isn't a bottleneck.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UtilizationPercent":{
            "type":"number",
            "description":"Percentage of how much a resource is utilized.",
            "nullable":true
        },
        "AvailableAllDayIndicator":{
            "type":"integer",
            "description":"Value that indicates whether the resource is available 24 hours a day or not. Valid values are: 1 or 2. If 1, then resource is available 24 hours a day. If 2, then not.",
            "nullable":false
        },
        "AvailableAllDayResource":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates whether the resource is available 24 hours a day or not. Valid values are: Yes or No. If Yes, then the resource is available 24 hours a day. If No, then the resource isn't available 24 hours a day.",
            "nullable":true
        },
        "Critical":{
            "type":"integer",
            "description":"Value that indicates whether the resource is critical to honor resource capacity constraint or not. Valid values are: 1 or 2. If 1, then the resource is critical. If 2, then the resource isn't critical.",
            "nullable":true
        },
        "EfficiencyPercent":{
            "type":"number",
            "description":"Percentage of the actual output compared to the expected standard output.",
            "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:
  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 : supplyPlans-Resources-item-response

Type: object

Show Source

• AvailableAllDayIndicator: integer
  Value that indicates whether the resource is available 24 hours a day or not. Valid values are: 1 or 2. If 1, then resource is available 24 hours a day. If 2, then not.
• AvailableAllDayResource: string
  Maximum Length: 4000

  Value that indicates whether the resource is available 24 hours a day or not. Valid values are: Yes or No. If Yes, then the resource is available 24 hours a day. If No, then the resource isn't available 24 hours a day.
• Bottleneck: string
  Maximum Length: 4000

  Value that indicates whether the resource is a bottleneck resource or not. Valid values are: 1 or 2. If 1, then resource is a bottleneck. If 2, then not.
• BottleneckIndicator: integer
  Value that indicates whether the resource is a bottleneck or not. Valid values are: Yes or No. If Yes, then the resource is a bottleneck. If No, then the resource isn't a bottleneck.
• CapacityUnits: number
  Read Only: true

  Number of units of this resource that are available.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the resource.
• Critical: integer
  Value that indicates whether the resource is critical to honor resource capacity constraint or not. Valid values are: 1 or 2. If 1, then the resource is critical. If 2, then the resource isn't critical.
• CriticalResource: string
  Maximum Length: 4000

  Value that indicates whether the resource is critical to honor the resource capacity constraint or not. Valid values are: Yes or No. If Yes, then the resource is critical. If No, then the resource isn't critical.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 4000

  Code for the currency in which the resource cost is defined.
• DisableDate: string (date)
  Read Only: true

  Date when the resource is no longer available.
• EfficiencyPercent: number
  Percentage of the actual output compared to the expected standard output.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotesCount: integer
  Read Only: true

  Value that's used to enable Create Note or Manage Notes. Valid values are 1 or 2. If 1, then Create Note is enabled. If 2, Manage Notes is enabled. The default value is 1.
• Organization: string
  Read Only: true

  Maximum Length: 4000

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization.
• PlanId: integer (int64)
  Unique identifier of the plan.
• ResourceCode: string
  Read Only: true

  Maximum Length: 40

  Abbreviation that identifies the resource.
• ResourceCost: number
  Read Only: true

  Cost associated with using the resource.
• ResourceDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource.
• ResourceName: string
  Read Only: true

  Maximum Length: 80

  Name of the resource.
• ResourceType: integer
  Read Only: true

  Value that identifies the type of resource. Valid values are 1 or 2. If 1, then the resource is a piece of equipment. If 2, then the resource is a crew. A list of accepted values is defined in the lookup type ORA_MSC_RESOURCE_TYPE.
• ResourceTypeName: string
  Read Only: true

  Maximum Length: 4000

  Value that indicates the type of resource. Valid values are Equipment or Crew.
• ResourceUOM: string
  Read Only: true

  Maximum Length: 3

  Unit of measure associated with the resource.
• RowModified: string
  Read Only: true

  Text that identifies whether the resource record has been modified or is newly created in the simulation set. Valid values are Changed or Null. If it's Changed, then the resource record has been modified or newly created in the simulation set. If it's Null, then the resource record hasn't been modified or newly created in the simulation set.
• UnitOfMeasureDisplay: string
  Read Only: true

  Maximum Length: 4000

  Unit of measure associated with the resource.
• UtilizationPercent: number
  Percentage of how much a resource is utilized.
• WorkAreaCode: string
  Read Only: true

  Maximum Length: 120

  Abbreviation that identifies the work area.
• WorkAreaDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work area.
• WorkAreaName: string
  Read Only: true

  Maximum Length: 80

  Name of the work area.
• WorkCenterCode: string
  Read Only: true

  Maximum Length: 120

  Abbreviation that identifies the work center.
• WorkCenterDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work center.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center.
• WorkCenterName: string
  Read Only: true

  Maximum Length: 80

  Name of the work center.

{
    "type":"object",
    "properties":{
        "ResourceCost":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the resource.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Bottleneck":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates whether the resource is a bottleneck resource or not. Valid values are: 1 or 2. If 1, then resource is a bottleneck. If 2, then not.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceTypeName":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the type of resource. Valid values are Equipment or Crew.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":"4000",
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailableAllDayIndicator":{
            "type":"integer",
            "description":"Value that indicates whether the resource is available 24 hours a day or not. Valid values are: 1 or 2. If 1, then resource is available 24 hours a day. If 2, then not.",
            "nullable":false,
            "x-queryable":true
        },
        "CapacityUnits":{
            "type":"number",
            "description":"Number of units of this resource that are available.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Critical":{
            "type":"integer",
            "description":"Value that indicates whether the resource is critical to honor resource capacity constraint or not. Valid values are: 1 or 2. If 1, then the resource is critical. If 2, then the resource isn't critical.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"4000",
            "type":"string",
            "description":"Code for the currency in which the resource cost is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CriticalResource":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates whether the resource is critical to honor the resource capacity constraint or not. Valid values are: Yes or No. If Yes, then the resource is critical. If No, then the resource isn't critical.",
            "nullable":true,
            "x-queryable":true
        },
        "BottleneckIndicator":{
            "type":"integer",
            "description":"Value that indicates whether the resource is a bottleneck or not. Valid values are: Yes or No. If Yes, then the resource is a bottleneck. If No, then the resource isn't a bottleneck.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAreaName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UtilizationPercent":{
            "type":"number",
            "description":"Percentage of how much a resource is utilized.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the resource is no longer available.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasureDisplay":{
            "maxLength":"4000",
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":"40",
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotesCount":{
            "type":"integer",
            "description":"Value that's used to enable Create Note or Manage Notes. Valid values are 1 or 2. If 1, then Create Note is enabled. If 2, Manage Notes is enabled. The default value is 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Unique identifier of the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AvailableAllDayResource":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates whether the resource is available 24 hours a day or not. Valid values are: Yes or No. If Yes, then the resource is available 24 hours a day. If No, then the resource isn't available 24 hours a day.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceType":{
            "type":"integer",
            "description":"Value that identifies the type of resource. Valid values are 1 or 2. If 1, then the resource is a piece of equipment. If 2, then the resource is a crew. A list of accepted values is defined in the lookup type ORA_MSC_RESOURCE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RowModified":{
            "type":"string",
            "description":"Text that identifies whether the resource record has been modified or is newly created in the simulation set. Valid values are Changed or Null. If it's Changed, then the resource record has been modified or newly created in the simulation set. If it's Null, then the resource record hasn't been modified or newly created in the simulation set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAreaCode":{
            "maxLength":"120",
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceUOM":{
            "maxLength":"3",
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EfficiencyPercent":{
            "type":"number",
            "description":"Percentage of the actual output compared to the expected standard output.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the resource.",
            "format":"date-time",
            "nullable":false,
            "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