Jump to

• Request
• Response
• Examples

Get one resource

get

/fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/WorkCenterResource/{WorkCenterResourceUniqID}

Request

Path Parameters

• WorkCenterId(required): integer(int64)
  Value that uniquely identifies the work center. It is a primary key that the application generates when it creates a work center.
• WorkCenterResourceUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ResourceId and WorkCenterId ---for the Work Center Resources resource and used to uniquely identify an instance of Work Center Resources. The client should not generate the hash key value. Instead, the client should query on the Work Center Resources collection resource with a filter on the primary key values in order to navigate to a specific instance of Work Center Resources.
  
  For example: WorkCenterResource?q=ResourceId=<value1>;WorkCenterId=<value2>

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : workCenters-WorkCenterResource-item-response

Type: object

Show Source

• Available24HoursFlag: boolean
  Title: Available 24 Hours

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the work center resource is available 24 hours each day. If false, then the work center resource is not available 24 hours each day. A work center resource that is not available 24 hours each day is available only during the shifts that you assign to this work center resource. A work center resource is available in shifts only if this attribute is set to false. The default value is true.
• CheckCtpFlag: boolean
  Title: Check Capable to Promise

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then Oracle Global Order Promising Cloud considers the capacity of this work center resource during order promising. If false, then Global Order Promising does not consider this capacity. If this attribute is set to false, then the capable-to-promise (CTP) check does not consider the capacity of this work center resource. The default value is false.
• EfficiencyPercentage: number
  Title: Efficiency

  Default Value: 100

  Percent of time that the work center resource requires to finish the task.
• InactiveDate: string (date)
  Read Only: true

  Date when the resource becomes inactive.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

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

  Maximum Length: 80

  Name of the work center resource.
• ResourceQuantity: number
  Title: Default Units Available

  Number of work center resources assigned to this work center.
• ResourceType: string
  Read Only: true

  Maximum Length: 30

  Indicates the type of the resource, equipment, or labor.
• ResourceTypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Indicates the type of the resource, equipment, or labor.
• UtilizationPercentage: number
  Title: Utilization

  Default Value: 100

  Percent of time that is available to perform the task.
• WcProdCalendarId: integer
  Value that uniquely identifies the work center production calendars record. This is an application generated unique ID.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center that this work center resource references.
• WorkCenterResourceShift: array Shifts for Work Center Resources
  Title: Shifts for Work Center Resources

  The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.

{
    "type":"object",
    "properties":{
        "InactiveDate":{
            "type":"string",
            "description":"Date when the resource becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the work center resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center that this work center resource references.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Available24HoursFlag":{
            "title":"Available 24 Hours",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the work center resource is available 24 hours each day. If false, then the work center resource is not available 24 hours each day. A work center resource that is not available 24 hours each day is available only during the shifts that you assign to this work center resource. A work center resource is available in shifts only if this attribute is set to false. The default value is true.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the work center resource.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the resource, equipment, or labor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EfficiencyPercentage":{
            "title":"Efficiency",
            "type":"number",
            "description":"Percent of time that the work center resource requires to finish the task.",
            "nullable":true,
            "default":"100",
            "x-queryable":false
        },
        "WcProdCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center production calendars record. This is an application generated unique ID.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterResourceShift":{
            "title":"Shifts for Work Center Resources",
            "type":"array",
            "description":"The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.",
            "items":{
                "$ref":"#/components/schemas/workCenters-WorkCenterResource-WorkCenterResourceShift-item-response"
            }
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work center resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center resource. It is a primary key that the application generates when it creates a work center resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceQuantity":{
            "title":"Default Units Available",
            "type":"number",
            "description":"Number of work center resources assigned to this work center.",
            "nullable":false,
            "x-queryable":false
        },
        "CheckCtpFlag":{
            "title":"Check Capable to Promise",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then Oracle Global Order Promising Cloud considers the capacity of this work center resource during order promising. If false, then Global Order Promising does not consider this capacity. If this attribute is set to false, then the capable-to-promise (CTP) check does not consider the capacity of this work center resource. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ResourceTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of the resource, equipment, or labor.",
            "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"
            }
        },
        "UtilizationPercentage":{
            "title":"Utilization",
            "type":"number",
            "description":"Percent of time that is available to perform the task.",
            "nullable":true,
            "default":"100",
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Shifts for Work Center Resources

Type: array

Title: Shifts for Work Center Resources

The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.

Show Source

• Array of: object workCenters-WorkCenterResource-WorkCenterResourceShift-item-response

{
    "title":"Shifts for Work Center Resources",
    "type":"array",
    "description":"The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.",
    "items":{
        "$ref":"#/components/schemas/workCenters-WorkCenterResource-WorkCenterResourceShift-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 : workCenters-WorkCenterResource-WorkCenterResourceShift-item-response

Type: object

Show Source

• AssignedUnits: number
  Number of resources assigned to the shift.
• Duration: string
  Read Only: true

  Maximum Length: 255

  Duration of the shift.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlantCalendarId: integer
  Read Only: true

  Value that uniquely identifies the plant calendar that the plant calendar references.
• ShiftId: integer (int64)
  Value that uniquely identifies the shift that the shift references.
• ShiftName: string
  Read Only: true

  Name of the shift.
• StartTime: string
  Read Only: true

  Start time of the shift.
• WorkCenterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work center that this work center resource references.

{
    "type":"object",
    "properties":{
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center that this work center resource references.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShiftName":{
            "type":"string",
            "description":"Name of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUnits":{
            "type":"number",
            "description":"Number of resources assigned to the shift.",
            "nullable":false,
            "x-queryable":true
        },
        "PlantCalendarId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plant calendar that the plant calendar references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "type":"string",
            "description":"Start time of the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiftId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shift that the shift references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Duration":{
            "maxLength":"255",
            "type":"string",
            "description":"Duration of the shift.",
            "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"
    }
}

Links

WorkCenterResourceShift

Operation: /fscmRestApi/resources/11.13.18.05/workCenters/{WorkCenterId}/child/WorkCenterResource/{WorkCenterResourceUniqID}/child/WorkCenterResourceShift

Parameters:

• WorkCenterId: $request.path.WorkCenterId
• WorkCenterResourceUniqID: $request.path.WorkCenterResourceUniqID

The Shifts for Work Center Resources manages the shifts for each work center resource. The application automatically creates each shift when you assign a production resource to a work center.

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/workCenters/WorkCenterId/child/WorkCenterResource/WorkCenterResourceUniqID"

For example, the following command gets one resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/workCenters/WorkCenterId/child/WorkCenterResource?q=ResourceId=300100073217879;WorkCenterId=300100073218337"

Example Response Body

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

{
      "ResourceId" : 300100073217879,
      "ResourceName" : "CST_Resource",
      "ResourceDescription" : "Resource Created to Test Cost Planning Tests",
      "WorkCenterId" : 300100073218337,
      "ResourceQuantity" : 100,
      "Available24HoursFlag" : true,
      "CheckCtpFlag" : true,
      "UtilizationPercentage" : 90,
      "EfficiencyPercentage" : 80,
      "links" : [ {
        ...
        }]
}

Back to Top