Jump to

• Request
• Response

POST action not supported

post

/fscmRestApi/resources/11.13.18.05/configuratorModels/{configuratorModelsUniqID}/child/versions/{versionsUniqID}/child/ruleFolders/{RuleFolderId}/child/extensionRules

Request

Path Parameters

• RuleFolderId(required): integer(int64)
  Value that uniquely identifies the version of the configurator model.
• configuratorModelsUniqID(required): string
  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.
• versionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Versions resource and used to uniquely identify an instance of Versions. The client should not generate the hash key value. Instead, the client should query on the Versions collection resource in order to navigate to a specific instance of Versions to get the hash key.

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

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

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

Back to Top