1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Configurator Models

Get one model

get

/fscmRestApi/resources/11.13.18.05/configuratorModels/{configuratorModelsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Configurator Models resource and used to uniquely identify an instance of Configurator Models. The client should not generate the hash key value. Instead, the client should query on the Configurator Models collection resource in order to navigate to a specific instance of Configurator Models to get the hash key.
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 : configuratorModels-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the configurator model.
  • Title: Creation Date
    Read Only: true
    Date and time when the user created the configurator model.
  • Title: Description
    Maximum Length: 1000
    Description of the configurator model.
  • Read Only: true
    Maximum Length: 300
    Item that the configurator model references.
  • Read Only: true
    Maximum Length: 240
    Description of the item that the configurator model references. The value for this attribute is defined in Oracle Product Information Management Cloud.
  • Read Only: true
    Value that uniquely identifies the part, item, product, or service.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the configurator model.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the configurator model.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 255
    Name of the configurator model.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization associated with the configurator model.
  • Read Only: true
    Value that uniquely identifies the organization associated with the configurator model.
  • Read Only: true
    Maximum Length: 240
    Name of the organization associated with the configurator model.
  • Versions
    Title: Versions
    The Versions resource gets the details for a specific model version in the context of a workspace.
Nested Schema : Versions
Type: array
Title: Versions
The Versions resource gets the details for a specific model version in the context of a workspace.
Show Source
Nested Schema : configuratorModels-versions-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created this version of the configurator model.
  • Read Only: true
    Date and time when the user created this version of the configurator model.
  • Title: Effective Start Date
    Read Only: true
    Effective start date when the modifications in the workspace go into effect during release.
  • Read Only: true
    Date and time when the user most recently updated the version of the configurator model.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the version of the configurator model.
  • Links
  • Rule Folders
    Title: Rule Folders
    The Rule Folders resource manages rule folders for a specific model version.
  • Read Only: true
    Maximum Length: 40
    Version number that the application creates for the configurator model. The application assigns a Draft version to each model that it adds to the workspace. The application assigns a consecutive numeric value to each released version, such as version 1.0, version 2.0, and so on. You cannot edit the version number.
  • Title: Name
    Read Only: true
    Maximum Length: 255
    Name of the workspace to use for the configurator model. You use a workspace to edit and test drafts of changes that you make to each configurator model.
  • Title: Description
    Read Only: true
    Maximum Length: 1000
    Description of the workspace that the configurator model uses.
Nested Schema : Rule Folders
Type: array
Title: Rule Folders
The Rule Folders resource manages rule folders for a specific model version.
Show Source
Nested Schema : configuratorModels-versions-ruleFolders-item-response
Type: object
Show Source
Nested Schema : Extension Rules
Type: array
Title: Extension Rules
The Extension Rules resource gets extension rule details for a specific model version.
Show Source
Nested Schema : Rule Folders
Type: array
Title: Rule Folders
The Rule Folders resource manages rule folders for a specific model version.
Show Source
Nested Schema : configuratorModels-versions-ruleFolders-extensionRules-item-response
Type: object
Show Source
  • Read Only: true
    Value that indicates the base node associated with the extension rule.
  • Read Only: true
    Maximum Length: 64
    User who created the extension rule.
  • Read Only: true
    Date and time when the user created the extension rule.
  • Title: Description
    Read Only: true
    Maximum Length: 1000
    Description of the extension rule.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the rule is considered enabled and the rule logic will be employed at runtime. If false, then the rule logic will be disabled at runtime. The default value is true.
  • Read Only: true
    Date when the extension rule becomes invalid because one of the participants in the rule was end-dated.
  • Read Only: true
    Contains one of the following values: Instance or Instance Set. When the rule is invoked, the instantiation scope dictates whether a separate instance of the rule is created for each instance of the base node, or a single instance of the rule is created for the whole set of instances of the base node.
  • Read Only: true
    Maximum Length: 30
    Value that indicates the instantiation scope. Valid values include ORA_INSTANCE or ORA_INSTANCE_SET.
  • Read Only: true
    Date and time when the user most recently updated the extension rule.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the extension rule.
  • Links
  • Title: Name
    Read Only: true
    Maximum Length: 255
    Name of the extension rule.
  • Read Only: true
    Value that uniquely identifies the extension rule.
  • Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.
  • Read Only: true
    Value that indicates the status of the extension rule. Valid values include Valid, Modified, or Error.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the extension rule status. Valid values include UNKNOWN, VALIDATED, VALIDATION_FAILED, LOGIC_GENERATED, or LOGIC_FAILED.
  • Read Only: true
    Maximum Length: 14
    Type of configurator rule. Valid value is Extension Rule.
Nested Schema : configuratorModels-versions-ruleFolders-ruleFolders-item-response
Type: object
Show Source
Links
versions
Parameters:
  • configuratorModelsUniqID: $request.path.configuratorModelsUniqID
The Versions resource gets the details for a specific model version in the context of a workspace.
Back to Top

Examples

This example describes how to get one model.

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/configuratorModels/configuratorModelsUniqID"

Example Response Body

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

{
    "Name": "AT6751010",
    "Description": "Vision 5001 Custom Tablet",
    "Item": "AT6751010",
    "ItemDescription": "Vision 5001 Custom Tablet",
    "ItemId": 300100075148231,
    "Organization": "V1",
    "OrganizationName": "Vision Operations",
    "OrganizationId": 204,
    "CreationDate": "2019-12-07T23:16:47.457+00:00",
    "CreatedBy": "JRSMITH",
    "LastUpdateDate": "2019-12-07T23:16:47.457+00:00",
    "LastUpdatedBy": "JRSMITH"
}
Back to Top