Get one resource

get

/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/Resources/{ResourceId}

Request

Path Parameters
  • 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=
  • 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=
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : planInputs-Resources-item-response
Type: object
Show Source
  • Read Only: true
    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.
  • 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.
  • 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.
  • Read Only: true
    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.
  • Read Only: true
    Maximum Length: 4000
    Indicates whether the Capable to Promise option is enabled while using Oracle Fusion Global Order Promising to promise for the end item or assembly. Valid values are: Yes or No. If Yes, then Capable to Promise is enabled. If No, then Capable to Promise isn't enabled.
  • Read Only: true
    Number of units of this resource that are available.
  • Read Only: true
    Maximum Length: 64
    User who created the resource.
  • Read Only: true
    Date and time when the user created the resource.
  • Read Only: true
    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.
  • 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.
  • Read Only: true
    Value that indicates whether the resource is used for Oracle Fusion Global Order Promising Capable to Promise feature or not. Valid values are: 1 or 2. If 1, then resource is used. If 2, then not.
  • Read Only: true
    Maximum Length: 4000
    Code for the currency in which the resource cost is defined.
  • Read Only: true
    Date when the resource is no longer available.
  • Read Only: true
    Percentage of the actual output compared to the expected standard output.
  • Read Only: true
    Date and time when the user most recently updated the resource.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the resource.
  • Links
  • 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.
  • Read Only: true
    Maximum Length: 4000
    Abbreviation that identifies the organization.
  • Read Only: true
    Value that uniquely identifies the organization.
  • Resource Capacities
    Title: Resource Capacities
    The Resource Capacities resource manages how many hours a resource is available for each day.
  • Read Only: true
    Maximum Length: 40
    Abbreviation that identifies the resource.
  • Read Only: true
    Cost associated with using the resource.
  • Read Only: true
    Maximum Length: 240
    Description of the resource.
  • Read Only: true
    Value that uniquely identifies the resource.
  • Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Read Only: true
    Value that identifies the type of resource. Valid values are 1 or 2. If 1, then the resource is a piece of equipment. If 2, then the resource is a crew. A list of accepted values is defined in the lookup type ORA_MSC_RESOURCE_TYPE.
  • Read Only: true
    Maximum Length: 4000
    Value that indicates the type of resource. Valid values are Equipment or Crew.
  • Read Only: true
    Maximum Length: 3
    Unit of measure associated with the resource.
  • Read Only: true
    Maximum Length: 4000
    Unit of measure associated with the resource.
  • Read Only: true
    Percentage of how much a resource is utilized.
  • Read Only: true
    Maximum Length: 120
    Abbreviation that identifies the work area.
  • Read Only: true
    Maximum Length: 240
    Description of the work area.
  • Read Only: true
    Value that uniquely identifies the work area.
  • Read Only: true
    Maximum Length: 80
    Name of the work area.
  • Read Only: true
    Maximum Length: 120
    Abbreviation that identifies the work center.
  • Read Only: true
    Maximum Length: 240
    Description of the work center.
  • Read Only: true
    Value that uniquely identifies the work center.
  • Read Only: true
    Maximum Length: 80
    Name of the work center.
Nested Schema : Resource Capacities
Type: array
Title: Resource Capacities
The Resource Capacities resource manages how many hours a resource is available for each day.
Show Source
Nested Schema : planInputs-Resources-ResourceCapacities-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get one resource.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/planInputs/PlanInputId/child/Resources/ResourceId"

For example, the following command gets one resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Resources/25126"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"ResourceId": 25126,
	"ResourceCode": "LH-eBook3G-Line2",
	"ResourceName": "LH-eBook3G-Line2",
	"ResourceDescription": "eBook3G Line2",
	"WorkCenterId": 25125,
	"WorkCenterCode": "LH-eBook3G-WC1",
	"WorkCenterName": "LH-eBook3G-WC1",
	"WorkCenterDescription": "LH-eBook3G-WC1",
	"WorkAreaId": 25123,
	"WorkAreaCode": "LH-eBook3G-WA1",
	"WorkAreaName": "LH-eBook3G-WA1",
	"WorkAreaDescription": "eBook3G WA1",
	"OrganizationId": 10022,
	"OrganizationCode": "CAWAB",
	"ResourceType": 2,
	"ResourceUOM": "HRS",
	"CapacityUnits": 2,
	"BottleneckIndicator": 2,
	"EfficiencyPercent": 100,
	"UtilizationPercent": 100,
	"ResourceCost": 30,
	"AvailableAllDayIndicator": 1,
	"CtpIndicator": 2,
	"DisableDate": "2025-01-01",
	"CreatedBy": "OPERATIONS",
	"CreationDate": "2017-07-27T16:49:59.578+00:00",
	"LastUpdatedBy": "OPERATIONS",
	"LastUpdateDate": "2017-07-27T16:49:59.578+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Resources/25126",
		"name": "Resources",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Resources/25126",
		"name": "Resources",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/planInputs/-1",
		"name": "planInputs",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/planInputs/-1/child/Resources/25126/child/ResourceCapacities",
		"name": "ResourceCapacities",
		"kind": "collection"
	}
	]
}
Back to Top