Jump to

• Request
• Response

Update a configuration field

patch

/fscmRestApi/resources/11.13.18.05/publicSectorScopeConfigurationFields/{publicSectorScopeConfigurationFieldsUniqID}

Request

Path Parameters

• publicSectorScopeConfigurationFieldsUniqID(required): string
  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: publicSectorScopeConfigurationFields?q=ScopeConfigId=<value1>;ScopeFieldId=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AltKeyAttrb: string
  Title: Alternate Key Field

  Maximum Length: 100

  The alternate unique identifier of the scope configuration setup data.
• AltKeyReference: string
  Title: Reference Business Object

  Maximum Length: 50

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

  Maximum Length: 1

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

  Default Value: N

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

  Maximum Length: 160

  The attribute label string that is displayed on the scope selection page.
• FieldName: string
  Title: Field Name

  Maximum Length: 100

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

  Maximum Length: 20

  The attribute type of the scope configuration field setup data.
• ReturnToFsmFlag: boolean
  Title: Return to Functional Setup Manager

  Maximum Length: 1

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

  Maximum Length: 50

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

  Maximum Length: 12

  The unique identifier of the scope configuration field setup.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the seed data lock status of the scope configuration setup.

{
    "type":"object",
    "properties":{
        "FieldLabelString":{
            "title":"Label String Key",
            "maxLength":"160",
            "type":"string",
            "description":"The attribute label string that is displayed on the scope selection page.",
            "nullable":true
        },
        "AutoKeyFlag":{
            "title":"Surrogate Field",
            "maxLength":"1",
            "type":"boolean",
            "description":"The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the deleted status of scope configuration field setup.",
            "nullable":false,
            "default":"N"
        },
        "ReturnToFsmFlag":{
            "title":"Return to Functional Setup Manager",
            "maxLength":"1",
            "type":"boolean",
            "description":"The attribute to determine whether the field value is used as a scope for data filtration.",
            "nullable":false
        },
        "ScopeFieldId":{
            "title":"Field ID",
            "maxLength":"12",
            "type":"string",
            "description":"The unique identifier of the scope configuration field setup.",
            "nullable":false
        },
        "AltKeyAttrb":{
            "title":"Alternate Key Field",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate unique identifier of the scope configuration setup data.",
            "nullable":true
        },
        "AltKeyReference":{
            "title":"Reference Business Object",
            "maxLength":"50",
            "type":"string",
            "description":"The reference attribute name of the alternate attribute for the scope configuration field setup data.",
            "nullable":true
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute name of the scope configuration field setup data.",
            "nullable":false
        },
        "ScopeConfigId":{
            "title":"Scope Configuration ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "nullable":false
        },
        "FieldType":{
            "title":"Field Type",
            "maxLength":"20",
            "type":"string",
            "description":"The attribute type of the scope configuration field setup data.",
            "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:
  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 : publicSectorScopeConfigurationFields-item-response

Type: object

Show Source

• AltKeyAttrb: string
  Title: Alternate Key Field

  Maximum Length: 100

  The alternate unique identifier of the scope configuration setup data.
• AltKeyReference: string
  Title: Reference Business Object

  Maximum Length: 50

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

  Maximum Length: 1

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

  Default Value: N

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

  Maximum Length: 160

  The attribute label string that is displayed on the scope selection page.
• FieldName: string
  Title: Field Name

  Maximum Length: 100

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

  Maximum Length: 20

  The attribute type of the scope configuration field setup data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReturnToFsmFlag: boolean
  Title: Return to Functional Setup Manager

  Maximum Length: 1

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

  Maximum Length: 50

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

  Maximum Length: 12

  The unique identifier of the scope configuration field setup.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the seed data lock status of the scope configuration setup.

{
    "type":"object",
    "properties":{
        "FieldLabelString":{
            "title":"Label String Key",
            "maxLength":"160",
            "type":"string",
            "description":"The attribute label string that is displayed on the scope selection page.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoKeyFlag":{
            "title":"Surrogate Field",
            "maxLength":"1",
            "type":"boolean",
            "description":"The attribute to determine whether the scope configuration field setup data has an auto generated unique attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the seed data lock status of the scope configuration setup.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the deleted status of scope configuration field setup.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "ReturnToFsmFlag":{
            "title":"Return to Functional Setup Manager",
            "maxLength":"1",
            "type":"boolean",
            "description":"The attribute to determine whether the field value is used as a scope for data filtration.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ScopeFieldId":{
            "title":"Field ID",
            "maxLength":"12",
            "type":"string",
            "description":"The unique identifier of the scope configuration field setup.",
            "nullable":false,
            "x-queryable":true
        },
        "AltKeyAttrb":{
            "title":"Alternate Key Field",
            "maxLength":"100",
            "type":"string",
            "description":"The alternate unique identifier of the scope configuration setup data.",
            "nullable":true,
            "x-queryable":true
        },
        "AltKeyReference":{
            "title":"Reference Business Object",
            "maxLength":"50",
            "type":"string",
            "description":"The reference attribute name of the alternate attribute for the scope configuration field setup data.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldName":{
            "title":"Field Name",
            "maxLength":"100",
            "type":"string",
            "description":"The attribute name of the scope configuration field setup data.",
            "nullable":false,
            "x-queryable":true
        },
        "ScopeConfigId":{
            "title":"Scope Configuration ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the scope configuration setup.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldType":{
            "title":"Field Type",
            "maxLength":"20",
            "type":"string",
            "description":"The attribute type of the scope configuration field setup data.",
            "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"
    }
}

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