Jump to

• Request
• Response

Create a district

post

/fscmRestApi/resources/11.13.18.05/publicSectorDistricts

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorDistricts-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the district.
• CreationDate(optional): string(date-time)
  The date and time the district was created.
• Description(optional): string
  Title: District Description

  Maximum Length: 100

  The description of the district.
• DistrictId(optional): string
  Title: District ID

  Maximum Length: 30

  The unique identifier of the district.
• DistrictType(optional): string
  Title: District Type

  Maximum Length: 50

  The type of district.
• GisDistrictId(optional): string
  Title: District from GIS

  Maximum Length: 30

  Field on the District Details page where the user selects the corresponding GIS district. The valid values are the districts from the GIS district layer that is associated with the appropriate district type.
• LastUpdateDate(optional): string(date-time)
  The date and time the district was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the district."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the district was created."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the district.",
            "title":"District Description"
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the district.",
            "title":"District ID"
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of district.",
            "title":"District Type"
        },
        "GisDistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"Field on the District Details page where the user selects the corresponding GIS district. The valid values are the districts from the GIS district layer that is associated with the appropriate district type.",
            "title":"District from GIS"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the district was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the district."
        },
        "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 : publicSectorDistricts-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the district.
• CreationDate(optional): string(date-time)
  The date and time the district was created.
• Description(optional): string
  Title: District Description

  Maximum Length: 100

  The description of the district.
• DistrictId(optional): string
  Title: District ID

  Maximum Length: 30

  The unique identifier of the district.
• DistrictType(optional): string
  Title: District Type

  Maximum Length: 50

  The type of district.
• GisDistrictId(optional): string
  Title: District from GIS

  Maximum Length: 30

  Field on the District Details page where the user selects the corresponding GIS district. The valid values are the districts from the GIS district layer that is associated with the appropriate district type.
• LastUpdateDate(optional): string(date-time)
  The date and time the district was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

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

  Link Relations

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the district."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the district was created."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the district.",
            "title":"District Description"
        },
        "DistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the district.",
            "title":"District ID"
        },
        "DistrictType":{
            "maxLength":50,
            "type":"string",
            "description":"The type of district.",
            "title":"District Type"
        },
        "GisDistrictId":{
            "maxLength":30,
            "type":"string",
            "description":"Field on the District Details page where the user selects the corresponding GIS district. The valid values are the districts from the GIS district layer that is associated with the appropriate district type.",
            "title":"District from GIS"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the district was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the district."
        },
        "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