Jump to

• Request
• Response

POST action not supported

post

/fscmRestApi/resources/11.13.18.05/configuratorModels

Request

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.
• Upsert-Mode:
  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

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the configurator model.
• versions: array Versions
  Title: Versions

  The Versions resource gets the details for a specific model version in the context of a workspace.

{
    "type":"object",
    "properties":{
        "versions":{
            "title":"Versions",
            "type":"array",
            "description":"The Versions resource gets the details for a specific model version in the context of a workspace.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-item-post-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the configurator model.",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Versions",
    "type":"array",
    "description":"The Versions resource gets the details for a specific model version in the context of a workspace.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ruleFolders: array Rule Folders
  Title: Rule Folders

  The Rule Folders resource manages rule folders for a specific model version.

{
    "type":"object",
    "properties":{
        "ruleFolders":{
            "title":"Rule Folders",
            "type":"array",
            "description":"The Rule Folders resource manages rule folders for a specific model version.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-item-post-request"
            }
        }
    }
}

Nested Schema : Rule Folders

Type: array

Title: Rule Folders

The Rule Folders resource manages rule folders for a specific model version.

Show Source

• Array of: object configuratorModels-versions-ruleFolders-item-post-request

{
    "title":"Rule Folders",
    "type":"array",
    "description":"The Rule Folders resource manages rule folders for a specific model version.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-item-post-request"
    }
}

Nested Schema : configuratorModels-versions-ruleFolders-item-post-request

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the rule folder.
• extensionRules: array Extension Rules
  Title: Extension Rules

  The Extension Rules resource gets extension rule details for a specific model version.
• Name(required): string
  Title: Name

  Maximum Length: 255

  Name of the rule folder. You can use a rule folder to organize your rules into groups.
• ruleFolders: array Rule Folders
  Title: Rule Folders

  The Rule Folders resource manages rule folders for a specific model version.

{
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "extensionRules":{
            "title":"Extension Rules",
            "type":"array",
            "description":"The Extension Rules resource gets extension rule details for a specific model version.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-extensionRules-item-post-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the rule folder.",
            "nullable":true
        },
        "ruleFolders":{
            "title":"Rule Folders",
            "type":"array",
            "description":"The Rule Folders resource manages rule folders for a specific model version.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-ruleFolders-item-post-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the rule folder. You can use a rule folder to organize your rules into groups.",
            "nullable":false
        }
    }
}

Nested Schema : Extension Rules

Type: array

Title: Extension Rules

The Extension Rules resource gets extension rule details for a specific model version.

Show Source

• Array of: object configuratorModels-versions-ruleFolders-extensionRules-item-post-request

{
    "title":"Extension Rules",
    "type":"array",
    "description":"The Extension Rules resource gets extension rule details for a specific model version.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-extensionRules-item-post-request"
    }
}

Nested Schema : Rule Folders

Type: array

Title: Rule Folders

The Rule Folders resource manages rule folders for a specific model version.

Show Source

• Array of: object schema

{
    "title":"Rule Folders",
    "type":"array",
    "description":"The Rule Folders resource manages rule folders for a specific model version.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-ruleFolders-item-post-request"
    }
}

Nested Schema : configuratorModels-versions-ruleFolders-extensionRules-item-post-request

Type: object

Show Source

• RuleText: string
  Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.

{
    "type":"object",
    "properties":{
        "RuleText":{
            "type":"string",
            "description":"Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RuleTextClob"
                ]
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the rule folder.
• Name: string
  Title: Name

  Maximum Length: 255

  Name of the rule folder. You can use a rule folder to organize your rules into groups.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the rule folder.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the rule folder. You can use a rule folder to organize your rules into groups.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the configurator model.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the configurator model.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the configurator model.
• Item: string
  Read Only: true

  Maximum Length: 300

  Item that the configurator model references.
• ItemDescription: string
  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.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the part, item, product, or service.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the user most recently updated the configurator model.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who most recently updated the configurator model.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 255

  Name of the configurator model.
• Organization: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization associated with the configurator model.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization associated with the configurator model.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization associated with the configurator model.
• versions: array Versions
  Title: Versions

  The Versions resource gets the details for a specific model version in the context of a workspace.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization associated with the configurator model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the configurator model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the configurator model.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization associated with the configurator model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the configurator model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the configurator model.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization associated with the configurator model.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that the configurator model references. The value for this attribute is defined in Oracle Product Information Management Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part, item, product, or service.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the configurator model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":300,
            "type":"string",
            "description":"Item that the configurator model references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "versions":{
            "title":"Versions",
            "type":"array",
            "description":"The Versions resource gets the details for a specific model version in the context of a workspace.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the configurator model.",
            "format":"date-time",
            "nullable":false,
            "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 : Versions

Type: array

Title: Versions

The Versions resource gets the details for a specific model version in the context of a workspace.

Show Source

• Array of: object configuratorModels-versions-item-response

{
    "title":"Versions",
    "type":"array",
    "description":"The Versions resource gets the details for a specific model version in the context of a workspace.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-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 : configuratorModels-versions-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created this version of the configurator model.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created this version of the configurator model.
• EffectiveStartDate: string (date-time)
  Title: Effective Start Date

  Read Only: true

  Effective start date when the modifications in the workspace go into effect during release.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the version of the configurator model.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the version of the configurator model.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ruleFolders: array Rule Folders
  Title: Rule Folders

  The Rule Folders resource manages rule folders for a specific model version.
• Version: string
  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.
• Workspace: string
  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.
• WorkspaceDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  Description of the workspace that the configurator model uses.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the version of the configurator model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkspaceDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the workspace that the configurator model uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created this version of the configurator model.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created this version of the configurator model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Version":{
            "maxLength":40,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ruleFolders":{
            "title":"Rule Folders",
            "type":"array",
            "description":"The Rule Folders resource manages rule folders for a specific model version.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Effective start date when the modifications in the workspace go into effect during release.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "TimeZoneID":"#{applCorePrefs.UPTZ}"
            },
            "x-queryable":true
        },
        "Workspace":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the version of the configurator model.",
            "format":"date-time",
            "nullable":false,
            "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 : Rule Folders

Type: array

Title: Rule Folders

The Rule Folders resource manages rule folders for a specific model version.

Show Source

• Array of: object configuratorModels-versions-ruleFolders-item-response

{
    "title":"Rule Folders",
    "type":"array",
    "description":"The Rule Folders resource manages rule folders for a specific model version.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-item-response"
    }
}

Nested Schema : configuratorModels-versions-ruleFolders-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the rule folder.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the rule folder.
• extensionRules: array Extension Rules
  Title: Extension Rules

  The Extension Rules resource gets extension rule details for a specific model version.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the rule folder.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Name of the rule folder. You can use a rule folder to organize your rules into groups.
• RuleFolderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the version of the configurator model.
• ruleFolders: array Rule Folders
  Title: Rule Folders

  The Rule Folders resource manages rule folders for a specific model version.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the rule folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the rule folder.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the rule folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the rule folder.",
            "nullable":true,
            "x-queryable":true
        },
        "ruleFolders":{
            "title":"Rule Folders",
            "type":"array",
            "description":"The Rule Folders resource manages rule folders for a specific model version.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-ruleFolders-item-response"
            }
        },
        "extensionRules":{
            "title":"Extension Rules",
            "type":"array",
            "description":"The Extension Rules resource gets extension rule details for a specific model version.",
            "items":{
                "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-extensionRules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleFolderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the version of the configurator model.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the rule folder.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the rule folder. You can use a rule folder to organize your rules into groups.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Extension Rules

Type: array

Title: Extension Rules

The Extension Rules resource gets extension rule details for a specific model version.

Show Source

• Array of: object configuratorModels-versions-ruleFolders-extensionRules-item-response

{
    "title":"Extension Rules",
    "type":"array",
    "description":"The Extension Rules resource gets extension rule details for a specific model version.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-extensionRules-item-response"
    }
}

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 : Rule Folders

Type: array

Title: Rule Folders

The Rule Folders resource manages rule folders for a specific model version.

Show Source

• Array of: object configuratorModels-versions-ruleFolders-ruleFolders-item-response

{
    "title":"Rule Folders",
    "type":"array",
    "description":"The Rule Folders resource manages rule folders for a specific model version.",
    "items":{
        "$ref":"#/components/schemas/configuratorModels-versions-ruleFolders-ruleFolders-item-response"
    }
}

Nested Schema : configuratorModels-versions-ruleFolders-extensionRules-item-response

Type: object

Show Source

• BaseNode: string
  Read Only: true

  Value that indicates the base node associated with the extension rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the extension rule.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  Description of the extension rule.
• EnabledFlag: boolean
  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.
• EndDate: string (date-time)
  Read Only: true

  Date when the extension rule becomes invalid because one of the participants in the rule was end-dated.
• InstantiationScope: string
  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.
• InstantiationScopeCode: string
  Read Only: true

  Maximum Length: 30

  Value that indicates the instantiation scope. Valid values include ORA_INSTANCE or ORA_INSTANCE_SET.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the extension rule.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 255

  Name of the extension rule.
• RuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the extension rule.
• RuleText: string
  Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.
• Status: string
  Read Only: true

  Value that indicates the status of the extension rule. Valid values include Valid, Modified, or Error.
• StatusCode: string
  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.
• Type: string
  Read Only: true

  Maximum Length: 14

  Type of configurator rule. Valid value is Extension Rule.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Value that indicates the status of the extension rule. Valid values include Valid, Modified, or Error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstantiationScope":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the extension rule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the extension rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BaseNode":{
            "type":"string",
            "description":"Value that indicates the base node associated with the extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the extension rule status. Valid values include UNKNOWN, VALIDATED, VALIDATION_FAILED, LOGIC_GENERATED, or LOGIC_FAILED.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the extension rule becomes invalid because one of the participants in the rule was end-dated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Type":{
            "maxLength":14,
            "type":"string",
            "description":"Type of configurator rule. Valid value is Extension Rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleText":{
            "type":"string",
            "description":"Value that indicates the configurator extension rule text (groovy script) that describes the logic to be executed at runtime.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "RuleTextClob"
                ]
            },
            "x-queryable":true
        },
        "InstantiationScopeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the instantiation scope. Valid values include ORA_INSTANCE or ORA_INSTANCE_SET.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the extension rule.",
            "format":"date-time",
            "nullable":false,
            "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 : configuratorModels-versions-ruleFolders-ruleFolders-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the rule folder.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the rule folder.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the rule folder.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Name of the rule folder. You can use a rule folder to organize your rules into groups.
• RuleFolderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the version of the configurator model.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the rule folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the rule folder.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the rule folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the rule folder.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleFolderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the version of the configurator model.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the rule folder.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the rule folder. You can use a rule folder to organize your rules into groups.",
            "nullable":false,
            "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

versions

Operation: /fscmRestApi/resources/11.13.18.05/configuratorModels/{configuratorModelsUniqID}/child/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