Jump to

• Request
• Response

Update a global custom attribute

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBlRecords/{LnpRecordKey}/child/BlGlobalCustom/{LnpRecordKey3}

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning and is determined by the classification.
• LnpRecordKey3(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• BlGlobalCustomPuid: string
  Maximum Length: 480

  The unique identifier of the Business License Global Custom transaction record in the legacy system.
• ObjectVersionNumber: integer (int32)
  The system attribute that captures the incremental version number for an object.
• RecordNumber: string
  Maximum Length: 64

  The record number of the Business License transaction record in the legacy system.

{
    "type":"object",
    "properties":{
        "BlGlobalCustomPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the Business License Global Custom transaction record in the legacy system.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The record number of the Business License transaction record in the legacy system.",
            "nullable":true
        }
    }
}

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 : publicSectorBlRecords-BlGlobalCustom-item-response

Type: object

Show Source

• BlGlobalCustomPuid: string
  Maximum Length: 480

  The unique identifier of the Business License Global Custom transaction record in the legacy system.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the global custom attribute.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time of last update to the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The date when the record was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login session associated with the person who updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50

  The unique identifier for an application record.
• LnpRecordKey: integer (int64)
  The unique identifier for a record.
• ObjectVersionNumber: integer (int32)
  The system attribute that captures the incremental version number for an object.
• RecordNumber: string
  Maximum Length: 64

  The record number of the Business License transaction record in the legacy system.

{
    "type":"object",
    "properties":{
        "BlGlobalCustomPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The unique identifier of the Business License Global Custom transaction record in the legacy system.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the global custom attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time of last update to the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login session associated with the person who updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an application record.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The record number of the Business License transaction record in the legacy system.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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