Jump to

• Request
• Response
• Examples

Create resources

post

/fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Resources

Request

Path Parameters

• SimulationSetId(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=

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• AvailableAllDayIndicator(required): 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.
• BottleneckIndicator: integer
  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.
• CapacityUnits: number
  Number of units of the resource that are available.
• 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.
• DisableDate: string (date)
  Date when the resource is no longer available.
• EfficiencyPercent: number
  Percentage of the actual output compared to the expected standard output.
• NumberOfLineOperations: number
  Cost associated with using the resource.
• Organization: string
  Maximum Length: 4000

  Abbreviation that identifies the organization.
• OrganizationId(required): integer (int64)
  Value that uniquely identifies the organization.
• ResourceCapacities: array Resource Capacities
  Title: Resource Capacities

  The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.
• ResourceCode: string
  Maximum Length: 40

  Abbreviation that identifies the resource.
• ResourceCost: number
  Cost associated with using the resource.
• ResourceDescription: string
  Maximum Length: 240

  Description of the resource.
• ResourceId(required): integer (int64)
  Value that uniquely identifies the resource.
• ResourceName: string
  Maximum Length: 80

  Name of the resource.
• ResourceType: integer
  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.
• ResourceUOM: string
  Maximum Length: 3

  Unit of measure associated with the resource.
• RunRate: number
  Cost associated with using the resource.
• UtilizationPercent: number
  Percentage of how much a resource is utilized.
• WorkAreaCode: string
  Maximum Length: 120

  Abbreviation that identifies the work area.
• WorkAreaDescription: string
  Maximum Length: 240

  Description of the work area.
• WorkAreaId: integer (int64)
  Value that uniquely identifies the work area.
• WorkAreaName: string
  Maximum Length: 80

  Name of the work area.
• WorkCenterCode: string
  Maximum Length: 120

  Abbreviation that identifies the work center.
• WorkCenterDescription: string
  Maximum Length: 240

  Description of the work center.
• WorkCenterId(required): integer (int64)
  Value that uniquely identifies the work center.
• WorkCenterName: string
  Maximum Length: 80

  Name of the work center.

{
    "required":[
        "AvailableAllDayIndicator",
        "OrganizationId",
        "ResourceId",
        "WorkCenterId"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "BottleneckIndicator":{
            "type":"integer",
            "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
        },
        "CapacityUnits":{
            "type":"number",
            "description":"Number of units of the resource that are available.",
            "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
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the resource is no longer available.",
            "format":"date",
            "nullable":true
        },
        "EfficiencyPercent":{
            "type":"number",
            "description":"Percentage of the actual output compared to the expected standard output.",
            "nullable":true
        },
        "NumberOfLineOperations":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true
        },
        "Organization":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceCapacities":{
            "title":"Resource Capacities",
            "type":"array",
            "description":"The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.",
            "items":{
                "$ref":"#/components/schemas/simulationSets-Resources-ResourceCapacities-item-post-request"
            }
        },
        "ResourceCode":{
            "maxLength":40,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true
        },
        "ResourceCost":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true
        },
        "ResourceDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource.",
            "nullable":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
        },
        "ResourceUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true
        },
        "RunRate":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true
        },
        "UtilizationPercent":{
            "type":"number",
            "description":"Percentage of how much a resource is utilized.",
            "nullable":true
        },
        "WorkAreaCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":true
        },
        "WorkAreaDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkAreaName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work area.",
            "nullable":true
        },
        "WorkCenterCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true
        },
        "WorkCenterDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkCenterName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work center.",
            "nullable":true
        }
    }
}

Nested Schema : Resource Capacities

Type: array

Title: Resource Capacities

The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.

Show Source

• Array of: object schema

{
    "title":"Resource Capacities",
    "type":"array",
    "description":"The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.",
    "items":{
        "$ref":"#/components/schemas/simulationSets-Resources-ResourceCapacities-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AvailabilityDate: string (date)
  Date when the resource capacity is available.
• DailyAvailability: number
  Daily availability for each capacity unit of the resource.

{
    "type":"object",
    "properties":{
        "AvailabilityDate":{
            "type":"string",
            "description":"Date when the resource capacity is available.",
            "format":"date",
            "nullable":false
        },
        "DailyAvailability":{
            "type":"number",
            "description":"Daily availability for each capacity unit of the resource.",
            "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 : simulationSets-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
  Read Only: true

  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
  Read Only: true

  Maximum Length: 4000

  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.
• BottleneckIndicator: integer
  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.
• CapacityUnits: number
  Number of units of the 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
  Read Only: true

  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.
• DataSecurityEditAllowed: string
  Read Only: true

  Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.
• DisableDate: string (date)
  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.
• NotesIndicator: integer
  Read Only: true

  Cost associated with using the resource.
• NumberOfLineOperations: number
  Cost associated with using the resource.
• Organization: string
  Maximum Length: 4000

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• ResourceCapacities: array Resource Capacities
  Title: Resource Capacities

  The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.
• ResourceCode: string
  Maximum Length: 40

  Abbreviation that identifies the resource.
• ResourceCost: number
  Cost associated with using the resource.
• ResourceDescription: string
  Maximum Length: 240

  Description of the resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource.
• ResourceName: string
  Maximum Length: 80

  Name of the resource.
• ResourceType: integer
  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
  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 supply plan. Valid values are Changed or Null. If it's Changed, then the resource record has been modified or newly created in the supply plan. If it's Null, then the resource record hasn't been modified or newly created in the supply plan.
• RunRate: number
  Cost associated with using the resource.
• 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
  Maximum Length: 120

  Abbreviation that identifies the work area.
• WorkAreaDescription: string
  Maximum Length: 240

  Description of the work area.
• WorkAreaId: integer (int64)
  Value that uniquely identifies the work area.
• WorkAreaName: string
  Maximum Length: 80

  Name of the work area.
• WorkCenterCode: string
  Maximum Length: 120

  Abbreviation that identifies the work center.
• WorkCenterDescription: string
  Maximum Length: 240

  Description of the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center.
• WorkCenterName: string
  Maximum Length: 80

  Name of the work center.

{
    "type":"object",
    "properties":{
        "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
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "Bottleneck":{
            "maxLength":4000,
            "type":"string",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "BottleneckIndicator":{
            "type":"integer",
            "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
        },
        "CapacityUnits":{
            "type":"number",
            "description":"Number of units of the resource that are available.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the resource.",
            "nullable":false,
            "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
        },
        "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
        },
        "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,
            "readOnly":true,
            "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
        },
        "DataSecurityEditAllowed":{
            "type":"string",
            "description":"Contains one of the following: yes or null. If yes, then the user has data security edit privileges. If null, then the user doesn't have data security edit privileges.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisableDate":{
            "type":"string",
            "description":"Date when the resource is no longer available.",
            "format":"date",
            "nullable":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
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated 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
        },
        "NotesIndicator":{
            "type":"integer",
            "description":"Cost associated with using the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfLineOperations":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceCapacities":{
            "title":"Resource Capacities",
            "type":"array",
            "description":"The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.",
            "items":{
                "$ref":"#/components/schemas/simulationSets-Resources-ResourceCapacities-item-response"
            }
        },
        "ResourceCode":{
            "maxLength":40,
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceCost":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the resource.",
            "nullable":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
        },
        "ResourceName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the resource.",
            "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,
            "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
        },
        "ResourceUOM":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RowModified":{
            "type":"string",
            "description":"Text that identifies whether the resource record has been modified or is newly created in the supply plan. Valid values are Changed or Null. If it's Changed, then the resource record has been modified or newly created in the supply plan. If it's Null, then the resource record hasn't been modified or newly created in the supply plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RunRate":{
            "type":"number",
            "description":"Cost associated with using the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasureDisplay":{
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure associated with the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UtilizationPercent":{
            "type":"number",
            "description":"Percentage of how much a resource is utilized.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAreaCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work area.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAreaDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work area.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAreaId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work area.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkAreaName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work area.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":120,
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Resource Capacities

Type: array

Title: Resource Capacities

The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.

Show Source

• Array of: object simulationSets-Resources-ResourceCapacities-item-response

{
    "title":"Resource Capacities",
    "type":"array",
    "description":"The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.",
    "items":{
        "$ref":"#/components/schemas/simulationSets-Resources-ResourceCapacities-item-response"
    }
}

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

Nested Schema : simulationSets-Resources-ResourceCapacities-item-response

Type: object

Show Source

• AvailabilityDate: string (date)
  Date when the resource capacity is available.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the resource capacity.
• DailyAvailability: number
  Daily availability for each capacity unit of the resource.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AvailabilityDate":{
            "type":"string",
            "description":"Date when the resource capacity is available.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the resource capacity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the resource capacity.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DailyAvailability":{
            "type":"number",
            "description":"Daily availability for each capacity unit of the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the resource capacity.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the resource capacity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

ResourceCapacities

Operation: /fscmRestApi/resources/11.13.18.05/simulationSets/{SimulationSetId}/child/Resources/{ResourceId}/child/ResourceCapacities

Parameters:

• ResourceId: $request.path.ResourceId
• SimulationSetId: $request.path.SimulationSetId

The Resource Capacities resource manages how many hours a resource is available for each day within a simulation set.

Back to Top

Examples

This example describes how to create resources.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"ResourceId" : 10904,
	"BottleneckIndicator": 2,
	"EfficiencyPercent": 100,
	"UtilizationPercent": 20,
	"AvailableAllDayIndicator": 1
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"ResourceId": 10904,
	"ResourceCode": "MFGADHOCLAB-C",
	"ResourceName": "MFGADHOCLAB-Costed",
	"ResourceDescription": "Adhoc Labour-Costed",
	"WorkCenterId": 300100073217933,
	"WorkCenterCode": "MFGQA2",
	"WorkCenterName": "MFGQA2",
	"WorkCenterDescription": "Work Center for QA",
	"WorkAreaId": 300100073217896,
	"WorkAreaCode": "MFGASSYWA2",
	"WorkAreaName": "MFGASSYWA2",
	"WorkAreaDescription": "Assembly Work Area2",
	"OrganizationId": 10000,
	"Organization": "V1",
	"ResourceType": 2,
	"ResourceUOM": "HRS",
	"CapacityUnits": 10,
	"BottleneckIndicator": 2,
	"EfficiencyPercent": 100,
	"UtilizationPercent": 20,
	"ResourceCost": null,
	"AvailableAllDayIndicator": 1,
	"DisableDate": null,
	"CreatedBy": "APS_ALL",
	"CreationDate": "2020-12-16T17:04:55.672+00:00",
	"LastUpdatedBy": "APS_ALL",
	"LastUpdateDate": "2020-12-16T17:04:55.049+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources/10904",
		"name": "Resources",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources/10904",
		"name": "Resources",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554",
		"name": "simulationSets",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources/10904/child/ResourceCapacities",
		"name": "ResourceCapacities",
		"kind": "collection"
	}
	]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"ResourceCode": "MFGADHOCLAB-NC",
	"WorkCenterCode": "MFGQA2",
	"Organization": "V1",
	"EfficiencyPercent": 100
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"ResourceId": 10904,
	"ResourceCode": "MFGADHOCLAB-C",
	"ResourceName": "MFGADHOCLAB-Costed",
	"ResourceDescription": "Adhoc Labour-Costed",
	"WorkCenterId": 300100073217933,
	"WorkCenterCode": "MFGQA2",
	"WorkCenterName": "MFGQA2",
	"WorkCenterDescription": "Work Center for QA",
	"WorkAreaId": 300100073217896,
	"WorkAreaCode": "MFGASSYWA2",
	"WorkAreaName": "MFGASSYWA2",
	"WorkAreaDescription": "Assembly Work Area2",
	"OrganizationId": 10000,
	"Organization": "V1",
	"ResourceType": 2,
	"ResourceUOM": "HRS",
	"CapacityUnits": 10,
	"BottleneckIndicator": 2,
	"EfficiencyPercent": 100,
	"UtilizationPercent": 20,
	"ResourceCost": null,
	"AvailableAllDayIndicator": 1,
	"DisableDate": null,
	"CreatedBy": "APS_ALL",
	"CreationDate": "2020-12-16T17:04:55.672+00:00",
	"LastUpdatedBy": "APS_ALL",
	"LastUpdateDate": "2020-12-16T17:04:55.049+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources/10904",
		"name": "Resources",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources/10904",
		"name": "Resources",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554",
		"name": "simulationSets",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/simulationSets/300100544099554/child/Resources/10904/child/ResourceCapacities",
		"name": "ResourceCapacities",
		"kind": "collection"
	}
	]
}

Back to Top