Jump to

• Request
• Response

Update a resource usage level

patch

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

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>
• usageLevelsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, WorkCenterId, ResourceId and StartDate ---for the Usage Levels resource and used to uniquely identify an instance of Usage Levels. The client should not generate the hash key value. Instead, the client should query on the Usage Levels collection resource with a filter on the primary key values in order to navigate to a specific instance of Usage Levels.
  
  For example: usageLevels?q=PlanId=<value1>;WorkCenterId=<value2>;ResourceId=<value3>;StartDate=<value4>

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

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

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