Jump to

• Request
• Response

Update a scope configuration

patch

/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• ScopeConfigId: string
  The unique identifier of the scope configuration setup.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorScopeConfigurations-item

Type: object

Show Source

• AltKeyName(optional): string
  Title: Alternate Key Name

  Maximum Length: 100

  The alternate identifier name of the scope configuration setup data.
• BoName(optional): string
  Title: Business Object

  Maximum Length: 255

  The name of the business object in the scope configuration setup data.
• DefaultScope(optional): string
  Maximum Length: 1000

  Indicates the default scope that will be applied to the business object during export.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates the deleted status of the scope configuration setup.
• EffdtMigrationMode(optional): string
  Maximum Length: 8

  Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode.
• links(optional): array Items
  Title: Items

  Link Relations
• ParentBoName(optional): string
  Title: Parent Business Object

  Maximum Length: 255

  The name of the parent business object in the scope configuration setup data.
• RowIdentifier(optional): string
  Maximum Length: 60

  The row identifier in the data XML.
• ScopeConfigDescr(optional): string
  Title: Description

  Maximum Length: 100

  The description about the scope configuration setup.
• ScopeConfigId(optional): string
  Title: Scope Configuration ID

  Maximum Length: 50

  The unique identifier of the scope configuration setup.
• ScopeConfigurationField(optional): array Scope Configuration Fields
  Title: Scope Configuration Fields

  The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.
• SeedDataLock(optional): integer(int32)
  Indicates the seed data lock status of the scope configuration setup.
• ServiceLabel(optional): string
  Title: Service Label

  Maximum Length: 255

  The label of the Scope Selection page.
• ServiceName(optional): string
  Title: Service Name

  Maximum Length: 100

  The name of the data service in the scope configuration setup.
• VoName(optional): string
  Title: View Object Name

  Maximum Length: 100

  The name of the view object in the scope configuration setup data.

{
    "properties":{
        "AltKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier name of the scope configuration setup data.",
            "title":"Alternate Key Name"
        },
        "BoName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the business object in the scope configuration setup data.",
            "title":"Business Object"
        },
        "DefaultScope":{
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the default scope that will be applied to the business object during export."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the deleted status of the scope configuration setup."
        },
        "EffdtMigrationMode":{
            "maxLength":8,
            "type":"string",
            "description":"Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode."
        },
        "ParentBoName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the parent business object in the scope configuration setup data.",
            "title":"Parent Business Object"
        },
        "RowIdentifier":{
            "maxLength":60,
            "type":"string",
            "description":"The row identifier in the data XML."
        },
        "ScopeConfigDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description about the scope configuration setup.",
            "title":"Description"
        },
        "ScopeConfigId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "title":"Scope Configuration ID"
        },
        "ScopeConfigurationField":{
            "items":{
                "$ref":"#/definitions/publicSectorScopeConfigurations-ScopeConfigurationField-item"
            },
            "type":"array",
            "description":"The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.",
            "title":"Scope Configuration Fields"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup."
        },
        "ServiceLabel":{
            "maxLength":255,
            "type":"string",
            "description":"The label of the Scope Selection page.",
            "title":"Service Label"
        },
        "ServiceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the data service in the scope configuration setup.",
            "title":"Service Name"
        },
        "VoName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the view object in the scope configuration setup data.",
            "title":"View Object Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Scope Configuration Fields

Type: array

Title: Scope Configuration Fields

The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.

Show Source

• Array of: object publicSectorScopeConfigurations-ScopeConfigurationField-item

{
    "items":{
        "$ref":"#/definitions/publicSectorScopeConfigurations-ScopeConfigurationField-item"
    },
    "type":"array",
    "description":"The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.",
    "title":"Scope Configuration Fields"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorScopeConfigurations-ScopeConfigurationField-item

Type: object

Show Source

• AltKeyAttrb(optional): string
  Title: Alternate Key Field

  Maximum Length: 100

  The alternative unique identifier of the scope configuration setup data.
• AltKeyReference(optional): string
  Title: Reference Business Object

  Maximum Length: 50

  The name of the reference attribute for the alternate attribute in the scope configuration field setup data.
• AutoKeyFlag(optional): boolean
  Title: Surrogate Field

  The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates the deleted status of the scope configuration field setup.
• FieldLabelString(optional): string
  Title: Label String Key

  Maximum Length: 160

  The attribute label string that is displayed on the Scope Selection page.
• FieldName(optional): string
  Title: Field Name

  Maximum Length: 100

  The attribute name of the scope configuration field setup data.
• FieldType(optional): string
  Title: Field Type

  Maximum Length: 20

  The attribute type of the scope configuration field setup data.
• links(optional): array Items
  Title: Items

  Link Relations
• ReturnToFsmFlag(optional): boolean
  Title: Return to Functional Setup Manager

  The attribute to determine whether the field value is used as a scope for data filtration.
• ScopeConfigId(optional): string
  Title: Scope Configuration ID

  Maximum Length: 50

  The unique identifier of the scope configuration setup.
• ScopeFieldId(optional): string
  Title: Field ID

  Maximum Length: 12

  The unique identifier of the scope configuration field setup.
• SeedDataLock(optional): integer(int32)
  Indicates the seed data lock status of the scope configuration setup.

{
    "properties":{
        "AltKeyAttrb":{
            "maxLength":100,
            "type":"string",
            "description":"The alternative unique identifier of the scope configuration setup data.",
            "title":"Alternate Key Field"
        },
        "AltKeyReference":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the reference attribute for the alternate attribute in the scope configuration field setup data.",
            "title":"Reference Business Object"
        },
        "AutoKeyFlag":{
            "type":"boolean",
            "description":"The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.",
            "title":"Surrogate Field"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the deleted status of the scope configuration field setup."
        },
        "FieldLabelString":{
            "maxLength":160,
            "type":"string",
            "description":"The attribute label string that is displayed on the Scope Selection page.",
            "title":"Label String Key"
        },
        "FieldName":{
            "maxLength":100,
            "type":"string",
            "description":"The attribute name of the scope configuration field setup data.",
            "title":"Field Name"
        },
        "FieldType":{
            "maxLength":20,
            "type":"string",
            "description":"The attribute type of the scope configuration field setup data.",
            "title":"Field Type"
        },
        "ReturnToFsmFlag":{
            "type":"boolean",
            "description":"The attribute to determine whether the field value is used as a scope for data filtration.",
            "title":"Return to Functional Setup Manager"
        },
        "ScopeConfigId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "title":"Scope Configuration ID"
        },
        "ScopeFieldId":{
            "maxLength":12,
            "type":"string",
            "description":"The unique identifier of the scope configuration field setup.",
            "title":"Field ID"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorScopeConfigurations-item

Type: object

Show Source

• AltKeyName(optional): string
  Title: Alternate Key Name

  Maximum Length: 100

  The alternate identifier name of the scope configuration setup data.
• BoName(optional): string
  Title: Business Object

  Maximum Length: 255

  The name of the business object in the scope configuration setup data.
• DefaultScope(optional): string
  Maximum Length: 1000

  Indicates the default scope that will be applied to the business object during export.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates the deleted status of the scope configuration setup.
• EffdtMigrationMode(optional): string
  Maximum Length: 8

  Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode.
• links(optional): array Items
  Title: Items

  Link Relations
• ParentBoName(optional): string
  Title: Parent Business Object

  Maximum Length: 255

  The name of the parent business object in the scope configuration setup data.
• RowIdentifier(optional): string
  Maximum Length: 60

  The row identifier in the data XML.
• ScopeConfigDescr(optional): string
  Title: Description

  Maximum Length: 100

  The description about the scope configuration setup.
• ScopeConfigId(optional): string
  Title: Scope Configuration ID

  Maximum Length: 50

  The unique identifier of the scope configuration setup.
• ScopeConfigurationField(optional): array Scope Configuration Fields
  Title: Scope Configuration Fields

  The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.
• SeedDataLock(optional): integer(int32)
  Indicates the seed data lock status of the scope configuration setup.
• ServiceLabel(optional): string
  Title: Service Label

  Maximum Length: 255

  The label of the Scope Selection page.
• ServiceName(optional): string
  Title: Service Name

  Maximum Length: 100

  The name of the data service in the scope configuration setup.
• VoName(optional): string
  Title: View Object Name

  Maximum Length: 100

  The name of the view object in the scope configuration setup data.

{
    "properties":{
        "AltKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The alternate identifier name of the scope configuration setup data.",
            "title":"Alternate Key Name"
        },
        "BoName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the business object in the scope configuration setup data.",
            "title":"Business Object"
        },
        "DefaultScope":{
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the default scope that will be applied to the business object during export."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the deleted status of the scope configuration setup."
        },
        "EffdtMigrationMode":{
            "maxLength":8,
            "type":"string",
            "description":"Indicates the migration mode for the effective dated setup table. The possible values are ORA_UPD for update and ORA_CUR for correction mode."
        },
        "ParentBoName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the parent business object in the scope configuration setup data.",
            "title":"Parent Business Object"
        },
        "RowIdentifier":{
            "maxLength":60,
            "type":"string",
            "description":"The row identifier in the data XML."
        },
        "ScopeConfigDescr":{
            "maxLength":100,
            "type":"string",
            "description":"The description about the scope configuration setup.",
            "title":"Description"
        },
        "ScopeConfigId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "title":"Scope Configuration ID"
        },
        "ScopeConfigurationField":{
            "items":{
                "$ref":"#/definitions/publicSectorScopeConfigurations-ScopeConfigurationField-item"
            },
            "type":"array",
            "description":"The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.",
            "title":"Scope Configuration Fields"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup."
        },
        "ServiceLabel":{
            "maxLength":255,
            "type":"string",
            "description":"The label of the Scope Selection page.",
            "title":"Service Label"
        },
        "ServiceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the data service in the scope configuration setup.",
            "title":"Service Name"
        },
        "VoName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the view object in the scope configuration setup data.",
            "title":"View Object Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Scope Configuration Fields

Type: array

Title: Scope Configuration Fields

The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.

Show Source

• Array of: object publicSectorScopeConfigurations-ScopeConfigurationField-item

{
    "items":{
        "$ref":"#/definitions/publicSectorScopeConfigurations-ScopeConfigurationField-item"
    },
    "type":"array",
    "description":"The scope configuration fields resource is used to enable the filtration of the setup data fields for the Functional Setup Manager export process. The resource shows the details of the filter criteria fields.",
    "title":"Scope Configuration Fields"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorScopeConfigurations-ScopeConfigurationField-item

Type: object

Show Source

• AltKeyAttrb(optional): string
  Title: Alternate Key Field

  Maximum Length: 100

  The alternative unique identifier of the scope configuration setup data.
• AltKeyReference(optional): string
  Title: Reference Business Object

  Maximum Length: 50

  The name of the reference attribute for the alternate attribute in the scope configuration field setup data.
• AutoKeyFlag(optional): boolean
  Title: Surrogate Field

  The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates the deleted status of the scope configuration field setup.
• FieldLabelString(optional): string
  Title: Label String Key

  Maximum Length: 160

  The attribute label string that is displayed on the Scope Selection page.
• FieldName(optional): string
  Title: Field Name

  Maximum Length: 100

  The attribute name of the scope configuration field setup data.
• FieldType(optional): string
  Title: Field Type

  Maximum Length: 20

  The attribute type of the scope configuration field setup data.
• links(optional): array Items
  Title: Items

  Link Relations
• ReturnToFsmFlag(optional): boolean
  Title: Return to Functional Setup Manager

  The attribute to determine whether the field value is used as a scope for data filtration.
• ScopeConfigId(optional): string
  Title: Scope Configuration ID

  Maximum Length: 50

  The unique identifier of the scope configuration setup.
• ScopeFieldId(optional): string
  Title: Field ID

  Maximum Length: 12

  The unique identifier of the scope configuration field setup.
• SeedDataLock(optional): integer(int32)
  Indicates the seed data lock status of the scope configuration setup.

{
    "properties":{
        "AltKeyAttrb":{
            "maxLength":100,
            "type":"string",
            "description":"The alternative unique identifier of the scope configuration setup data.",
            "title":"Alternate Key Field"
        },
        "AltKeyReference":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the reference attribute for the alternate attribute in the scope configuration field setup data.",
            "title":"Reference Business Object"
        },
        "AutoKeyFlag":{
            "type":"boolean",
            "description":"The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.",
            "title":"Surrogate Field"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the deleted status of the scope configuration field setup."
        },
        "FieldLabelString":{
            "maxLength":160,
            "type":"string",
            "description":"The attribute label string that is displayed on the Scope Selection page.",
            "title":"Label String Key"
        },
        "FieldName":{
            "maxLength":100,
            "type":"string",
            "description":"The attribute name of the scope configuration field setup data.",
            "title":"Field Name"
        },
        "FieldType":{
            "maxLength":20,
            "type":"string",
            "description":"The attribute type of the scope configuration field setup data.",
            "title":"Field Type"
        },
        "ReturnToFsmFlag":{
            "type":"boolean",
            "description":"The attribute to determine whether the field value is used as a scope for data filtration.",
            "title":"Return to Functional Setup Manager"
        },
        "ScopeConfigId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "title":"Scope Configuration ID"
        },
        "ScopeFieldId":{
            "maxLength":12,
            "type":"string",
            "description":"The unique identifier of the scope configuration field setup.",
            "title":"Field ID"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top