Jump to

• Request
• Response

Update a configuration field

patch

/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurations/{ScopeConfigId}/child/ScopeConfigurationField/{ScopeConfigurationFieldUniqID}

Request

Supported Media Types

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

Path Parameters

• ScopeConfigId: string
  The unique identifier of the scope configuration setup.
• ScopeConfigurationFieldUniqID: integer
  This is the hash key of the attributes which make up the composite key--- ScopeConfigId and ScopeFieldId ---for the Scope Configuration Fields resource and used to uniquely identify an instance of Scope Configuration Fields. The client should not generate the hash key value. Instead, the client should query on the Scope Configuration Fields collection resource with a filter on the primary key values in order to navigate to a specific instance of Scope Configuration Fields.
  
  For example: ScopeConfigurationField?q=ScopeConfigId=<value1>;ScopeFieldId=<value2>

Body ()

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

Root 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"
}

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

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

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

Back to Top