Jump to

• Request
• Response

Update a resource parameter

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/resourceParameters/{resourceParametersUniqID}

Request

Path Parameters

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

  This applies to manufacturing resources and indicates whether to apply user-defined ideal sequence: Y|N.
• ChangeoverCalculation: string
  Maximum Length: 12

  This applies to manufacturing resources and specifies whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence: Concurrent|Sequential.
• ChangeoverPosition: string
  Maximum Length: 12

  This applies to manufacturing resources and specifies whether changeovers shall be considered as setup or cleanup activities: Setup|Cleanup.
• ConstraintMode: string
  Maximum Length: 30

  Mode of the constraint. The format is RelaxCapacity|Relaxed|Constrained.
• DisplayResourceUnitsFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then a row is displayed for each resource unit. If N, then only a summary row is displayed. The default value is N.
• EnforceHorizonStartFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then horizon start is enforced during schedule generation. If N, then horizon start isn't enforced during schedule generation. This attribute doesn't have a default value.
• FixedTimeFence: number
  Value that indicates whether to allow specifying a resource-specific fixed time fence. This overrides the general fixed time fence defined within schedule options.
• FixedTimeFenceUnit: string
  Maximum Length: 12

  Time unit of measure for the fixed time fence. The format is seconds|minutes|hours|days.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• PrebuildMaximum: number
  Prebuild maximum considered by the dynamic resource allocation solver method.
• PrebuildMaximumFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then use prebuild maximum. If N, 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. The format is seconds|minutes|hours|days.
• RankIndependentAttributeCycleFlag: string
  Maximum Length: 1

  This applies to manufacturing resources and indicates whether to continue the user defined sequence.
• ResourceCode: string
  Maximum Length: 300

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

  Name of the resource used to define the resource parameters.
• RestartSequenceAtCycleBoundaryFlag: string
  Maximum Length: 1

  This applies to manufacturing resources and indicates whether the user-defined ideal attribute sequence shall be restarted at each scheduling cycle boundary during schedule generation: Y|N.
• WorkCenterCode: string
  Maximum Length: 100

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

  Name of the work center used to define the resource parameters.

{
    "type":"object",
    "properties":{
        "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 used to define the resource parameters.",
            "nullable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center for the resource that's used in the changeover. 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 used to define the resource parameters.",
            "nullable":true
        },
        "PrebuildMaximum":{
            "type":"number",
            "description":"Prebuild maximum considered by the dynamic resource allocation solver method.",
            "nullable":true
        },
        "PrebuildMaximumUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the prebuild maximum. The format is seconds|minutes|hours|days.",
            "nullable":true
        },
        "ConstraintMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mode of the constraint. The format is RelaxCapacity|Relaxed|Constrained.",
            "nullable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChangeoverCalculation":{
            "maxLength":"12",
            "type":"string",
            "description":"This applies to manufacturing resources and specifies whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence: Concurrent|Sequential.",
            "nullable":true
        },
        "ApplyIdealSequenceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"This applies to manufacturing resources and indicates whether to apply user-defined ideal sequence: Y|N.",
            "nullable":true
        },
        "RestartSequenceAtCycleBoundaryFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"This applies to manufacturing resources and indicates whether the user-defined ideal attribute sequence shall be restarted at each scheduling cycle boundary during schedule generation: Y|N.",
            "nullable":true
        },
        "FixedTimeFenceUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the fixed time fence. The format is seconds|minutes|hours|days.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RankIndependentAttributeCycleFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"This applies to manufacturing resources and indicates whether to continue the user defined sequence.",
            "nullable":true
        },
        "ChangeoverPosition":{
            "maxLength":"12",
            "type":"string",
            "description":"This applies to manufacturing resources and specifies whether changeovers shall be considered as setup or cleanup activities: Setup|Cleanup.",
            "nullable":true
        },
        "DisplayResourceUnitsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then a row is displayed for each resource unit. If N, then only a summary row is displayed. The default value is N.",
            "nullable":true
        },
        "PrebuildMaximumFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then use prebuild maximum. If N, 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 horizon start is enforced during schedule generation. If N, then horizon start isn't enforced during schedule generation. This attribute doesn't have a default value.",
            "nullable":true
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":false
        },
        "FixedTimeFence":{
            "type":"number",
            "description":"Value that indicates whether to allow specifying a resource-specific fixed time fence. This overrides the general fixed time fence defined within schedule options.",
            "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 : productionSchedulingOrganizations-resourceParameters-item-response

Type: object

Show Source

• ApplyIdealSequenceFlag: boolean
  Maximum Length: 1

  This applies to manufacturing resources and indicates whether to apply user-defined ideal sequence: Y|N.
• ChangeoverCalculation: string
  Maximum Length: 12

  This applies to manufacturing resources and specifies whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence: Concurrent|Sequential.
• ChangeoverPosition: string
  Maximum Length: 12

  This applies to manufacturing resources and specifies whether changeovers shall be considered as setup or cleanup activities: Setup|Cleanup.
• ConstraintMode: string
  Maximum Length: 30

  Mode of the constraint. The format is RelaxCapacity|Relaxed|Constrained.
• CreatedBy: string
  Read Only: true

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

  Contains one of the following values: Y or N. If Y, then a row is displayed for each resource unit. If N, then only a summary row is displayed. The default value is N.
• EnforceHorizonStartFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then horizon start is enforced during schedule generation. If N, then horizon start isn't enforced during schedule generation. This attribute doesn't have a default value.
• FixedTimeFence: number
  Value that indicates whether to allow specifying a resource-specific fixed time fence. This overrides the general fixed time fence defined within schedule options.
• FixedTimeFenceUnit: string
  Maximum Length: 12

  Time unit of measure for the fixed time fence. The format is seconds|minutes|hours|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.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• PrebuildMaximum: number
  Prebuild maximum considered by the dynamic resource allocation solver method.
• PrebuildMaximumFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then use prebuild maximum. If N, 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. The format is seconds|minutes|hours|days.
• RankIndependentAttributeCycleFlag: string
  Maximum Length: 1

  This applies to manufacturing resources and indicates whether to continue the user defined sequence.
• ResourceCode: string
  Maximum Length: 300

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

  Name of the resource used to define the resource parameters.
• RestartSequenceAtCycleBoundaryFlag: string
  Maximum Length: 1

  This applies to manufacturing resources and indicates whether the user-defined ideal attribute sequence shall be restarted at each scheduling cycle boundary during schedule generation: Y|N.
• WorkCenterCode: string
  Maximum Length: 100

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

  Name of the work center used to define the resource parameters.

{
    "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 for the resource that's used in the changeover. 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 used to define the resource parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "PrebuildMaximum":{
            "type":"number",
            "description":"Prebuild maximum considered by the dynamic resource allocation solver method.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeoverCalculation":{
            "maxLength":"12",
            "type":"string",
            "description":"This applies to manufacturing resources and specifies whether multiple changeover rules that apply at the same time shall be considered to occur concurrently or in sequence: Concurrent|Sequential.",
            "nullable":true,
            "x-queryable":true
        },
        "RestartSequenceAtCycleBoundaryFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"This applies to manufacturing resources and indicates whether the user-defined ideal attribute sequence shall be restarted at each scheduling cycle boundary during schedule generation: Y|N.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeoverPosition":{
            "maxLength":"12",
            "type":"string",
            "description":"This applies to manufacturing resources and specifies whether changeovers shall be considered as setup or cleanup activities: Setup|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
        },
        "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 used to define the resource parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrebuildMaximumUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the prebuild maximum. The format is seconds|minutes|hours|days.",
            "nullable":true,
            "x-queryable":true
        },
        "ConstraintMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Mode of the constraint. The format is RelaxCapacity|Relaxed|Constrained.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplyIdealSequenceFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"This applies to manufacturing resources and indicates whether to apply user-defined ideal sequence: Y|N.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedTimeFenceUnit":{
            "maxLength":"12",
            "type":"string",
            "description":"Time unit of measure for the fixed time fence. The format is seconds|minutes|hours|days.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RankIndependentAttributeCycleFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"This applies to manufacturing resources and indicates whether to continue the user defined sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayResourceUnitsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then a row is displayed for each resource unit. If N, then only a summary row is displayed. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PrebuildMaximumFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then use prebuild maximum. If N, 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 horizon start is enforced during schedule generation. If N, then horizon start isn't enforced during schedule generation. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedTimeFence":{
            "type":"number",
            "description":"Value that indicates whether to allow specifying a resource-specific fixed time fence. This overrides the general fixed time fence defined within schedule options.",
            "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 : 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