Jump to

• Request
• Response

Update a parcel district

patch

/fscmRestApi/resources/11.13.18.05/publicSectorParcelDistricts/{publicSectorParcelDistrictsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorParcelDistrictsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- ParcelId and DistrictId ---for the Parcel Districts resource and used to uniquely identify an instance of Parcel Districts. The client should not generate the hash key value. Instead, the client should query on the Parcel Districts collection resource with a filter on the primary key values in order to navigate to a specific instance of Parcel Districts.
  
  For example: publicSectorParcelDistricts?q=ParcelId=<value1>;DistrictId=<value2>

Body ()

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

Root Schema : publicSectorParcelDistricts-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the parcel district.
• CreationDate(optional): string(date-time)
  The date and time that the parcel district was created.
• DistrictId(optional): string
  Maximum Length: 30

  The unique identifier for a district.
• LastUpdateDate(optional): string(date-time)
  The date and time that the parcel district was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the parcel district.
• links(optional): array Items
  Title: Items

  Link Relations
• ParcelId(optional): integer(int64)
  The unique identifier for a parcel.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the parcel district."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the parcel district was created."
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a district."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the parcel district was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the parcel district."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a parcel."
        },
        "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 : publicSectorParcelDistricts-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the parcel district.
• CreationDate(optional): string(date-time)
  The date and time that the parcel district was created.
• DistrictId(optional): string
  Maximum Length: 30

  The unique identifier for a district.
• LastUpdateDate(optional): string(date-time)
  The date and time that the parcel district was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the parcel district.
• links(optional): array Items
  Title: Items

  Link Relations
• ParcelId(optional): integer(int64)
  The unique identifier for a parcel.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the parcel district."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the parcel district was created."
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a district."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the parcel district was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the parcel district."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a parcel."
        },
        "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