Jump to

• Request
• Response

Update one resource

patch

/fscmRestApi/resources/11.13.18.05/standardOperations/{StandardOperationId}/child/StandardOperationResource/{StandardOperationResourceId}/child/StandardOperationAlternateResource/{StandardOperationAlternateResourceId}

Request

Path Parameters

• StandardOperationAlternateResourceId(required): integer(int64)
  Value that uniquely identifies the alternative resource of a standard operation. It is a primary key that the application generates when it creates the alternative resource.
• StandardOperationId(required): integer(int64)
  Value that uniquely identifies the standard operation. It is a primary key that the application generates when it creates the standard operation.
• StandardOperationResourceId(required): integer(int64)
  Value that uniquely identifies the standard operation resource. It is a primary key that the application generates when it creates the resource.

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

• AssignedUnits: number
  Title: Units Assigned

  Number of resource units the application assigns to perform the operation for the alternative resource.
• InverseUsageRate: number
  Title: Inverse Usage

  Resource usage that the plant uses to make each unit of the item for the alternative resource. This value is the inverse of the usage rate. The application uses this inverse value when the usage rate for the alternative resource is a fraction, but the inverse of this rate is an integer.
• PriorityRanking: integer
  Priority ranking of the alternative resource to use in place of the primary resource.
• ResourceCode: string
  Title: Alternate Resources

  Maximum Length: 30

  Abbreviation that identifies the alternative resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the alternative resource. It is a primary key that the application generates when it creates the alternative resource.
• UsageRate: number
  Title: Usage

  Resource usage that the plant requires to make each unit of the item for the alternative resource.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "title":"Alternate Resources",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the alternative resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InverseUsageRate":{
            "title":"Inverse Usage",
            "type":"number",
            "description":"Resource usage that the plant uses to make each unit of the item for the alternative resource. This value is the inverse of the usage rate. The application uses this inverse value when the usage rate for the alternative resource is a fraction, but the inverse of this rate is an integer.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedUnits":{
            "title":"Units Assigned",
            "type":"number",
            "description":"Number of resource units the application assigns to perform the operation for the alternative resource.",
            "nullable":false,
            "x-queryable":false
        },
        "UsageRate":{
            "title":"Usage",
            "type":"number",
            "description":"Resource usage that the plant requires to make each unit of the item for the alternative resource.",
            "nullable":false
        },
        "PriorityRanking":{
            "type":"integer",
            "description":"Priority ranking of the alternative resource to use in place of the primary resource.",
            "nullable":false,
            "x-queryable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternative resource. It is a primary key that the application generates when it creates the alternative resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ResourceCode"
                ]
            }
        }
    }
}

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 : standardOperations-StandardOperationResource-StandardOperationAlternateResource-item-response

Type: object

Show Source

• AssignedUnits: number
  Title: Units Assigned

  Number of resource units the application assigns to perform the operation for the alternative resource.
• CostedFlag: boolean
  Title: Costing enabled

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then do not consider these costs. The default value is false.
• InverseUsageRate: number
  Title: Inverse Usage

  Resource usage that the plant uses to make each unit of the item for the alternative resource. This value is the inverse of the usage rate. The application uses this inverse value when the usage rate for the alternative resource is a fraction, but the inverse of this rate is an integer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriorityRanking: integer
  Priority ranking of the alternative resource to use in place of the primary resource.
• ResourceCode: string
  Title: Alternate Resources

  Maximum Length: 30

  Abbreviation that identifies the alternative resource.
• ResourceDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the alternative resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the alternative resource. It is a primary key that the application generates when it creates the alternative resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the alternative resource.
• ResourceType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Category of the alternative resource. Values include Labor or Equipment.
• StandardOperationAlternateResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the alternative resource of a standard operation. It is a primary key that the application generates when it creates the alternative resource.
• StandardOperationResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource that the standard operation uses. It is a primary key that the application generates when it creates the resource.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Unit of measure that the alternate resource uses.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the alternate resource uses.
• UsageRate: number
  Title: Usage

  Resource usage that the plant requires to make each unit of the item for the alternative resource.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "title":"Alternate Resources",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the alternative resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostedFlag":{
            "title":"Costing enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then do not consider these costs. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InverseUsageRate":{
            "title":"Inverse Usage",
            "type":"number",
            "description":"Resource usage that the plant uses to make each unit of the item for the alternative resource. This value is the inverse of the usage rate. The application uses this inverse value when the usage rate for the alternative resource is a fraction, but the inverse of this rate is an integer.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure that the alternate resource uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the alternative resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the alternative resource. Values include Labor or Equipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationAlternateResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternative resource of a standard operation. It is a primary key that the application generates when it creates the alternative resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssignedUnits":{
            "title":"Units Assigned",
            "type":"number",
            "description":"Number of resource units the application assigns to perform the operation for the alternative resource.",
            "nullable":false,
            "x-queryable":false
        },
        "UsageRate":{
            "title":"Usage",
            "type":"number",
            "description":"Resource usage that the plant requires to make each unit of the item for the alternative resource.",
            "nullable":false,
            "x-queryable":true
        },
        "PriorityRanking":{
            "type":"integer",
            "description":"Priority ranking of the alternative resource to use in place of the primary resource.",
            "nullable":false,
            "x-queryable":false
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the alternative resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternative resource. It is a primary key that the application generates when it creates the alternative resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ResourceCode"
                ]
            },
            "x-queryable":true
        },
        "StandardOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that the standard operation uses. It is a primary key that the application generates when it creates the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the alternate resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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