Jump to

• Request
• Response

Get all parcel import options

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelImportOptions

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds parcel import options that match the specified primary key criteria. Finder Variables:
    • AgencyId; integer; The unique identifier of the agency associated with the parcel import options.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorParcelImportOptions

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorParcelImportOptions-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorParcelImportOptions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorParcelImportOptions-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorParcelImportOptions-item

Type: object

Show Source

• Address2Flag(optional): boolean
  Title: Address Line 2

  Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically.
• CityFlag(optional): boolean
  Title: City

  Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address.
• DisableMissingAddressFlag(optional): boolean
  Title: Disable Addresses Not Found in Import File

  Indicates whether reference addresses in the database that are not in the address import file should be disabled. This option should only be used when the address import file contains a complete set of addresses for each parcel, including addresses with no changes.
• DisableMissingDistrictFlag(optional): boolean
  Title: Delete District Assignments Not Found in Import File

  Indicates whether parcel district assignments in your database that are not in the district import file should be deleted. This option should only be used when the district import file contains a complete set of districts for each parcel, including districts with no changes.
• DisableMissingParcelOwnerFlag(optional): boolean
  Title: Disable Owners Not Found in Import File

  Indicates whether reference owners in your database that are not in the owner import file should be disabled. This option should only be used when the owner import file contains a complete set of owners for each parcel, including owners with no changes.
• FloorFlag(optional): boolean
  Title: Floor

  Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address.
• ImportAddressDistrictFlag(optional): boolean
  Indicates whether an address district import file is to be processed by the Import Parcel Information process.
• ImportParcelAddressFlag(optional): boolean
  Indicates whether a parcel address import file is to be processed by the Import Parcel Information process.
• ImportParcelDistrictFlag(optional): boolean
  Indicates whether a parcel district import file is to be processed by the Import Parcel Information process.
• ImportParcelFlag(optional): boolean
  Indicates whether a parcel import file is to be processed by the Import Parcel Information process.
• ImportParcelOwnerFlag(optional): boolean
  Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process.
• ImportParcelValueFlag(optional): boolean
  Title: Value

  Indicates whether a parcel value import file is to be processed by the Import Parcel Information process.
• links(optional): array Items
  Title: Items

  Link Relations
• MapAddressDistrict(optional): string
  Maximum Length: 50

  Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the address district import file.
• MapParcel(optional): string
  Maximum Length: 50

  Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel import file.
• MapParcelAddress(optional): string
  Maximum Length: 50

  Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel address import file.
• MapParcelDistrict(optional): string
  Maximum Length: 50

  Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel district import file.
• MapParcelOwner(optional): string
  Maximum Length: 50

  Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel owner import file.
• MapParcelValue(optional): string
  Maximum Length: 50

  Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel value import file.
• OptionalProcessEight(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessFive(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessFour(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessNine(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessOne(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessSeven(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessSix(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessThree(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OptionalProcessTwo(optional): string
  Maximum Length: 20

  The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process.
• OwnerAddress2Flag(optional): string
  Title: Address Line 2

  Maximum Length: 1

  Indicates whether the attribute Address Line 2 should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• OwnerAddressFlag(optional): boolean
  Title: Address Line 1

  Indicates whether the attribute Address Line 1 should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• OwnerCityFlag(optional): boolean
  Title: City

  Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• OwnerNameFlag(optional): boolean
  Title: Owner Name

  Indicates whether the attribute Owner Name should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• OwnerPostalCodeFlag(optional): boolean
  Title: Postal Code

  Indicates whether the attribute Postal Code should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• OwnerStateFlag(optional): boolean
  Title: State

  Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• PostalCodeFlag(optional): boolean
  Title: Postal Code

  Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address.
• PreviewMode(optional): boolean
  Indicates whether the Import Parcel Information process should allow the user to review a list of parcel reference data to be inactivated prior to performing the updates.
• RetireMissingParcelFlag(optional): boolean
  Title: Retire Parcels Not Found in Import File

  Indicates whether reference parcels in the database that are not in the parcel import file should be retired. This option should only be used when the parcel import file contains a complete set of active parcels, including parcels with no changes.
• SecondaryOwnerNameFlag(optional): boolean
  Title: Secondary Owner

  Indicates whether the attribute Secondary Owner should be part of the combination of parcel owner attributes used to identify a new parcel owner.
• StateFlag(optional): boolean
  Title: State

  Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address.
• StreetDirectionFlag(optional): boolean
  Title: Direction Prefix

  Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address.
• StreetNameFlag(optional): boolean
  Title: Street Name

  Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address.
• StreetNumberFlag(optional): boolean
  Title: Street Number

  Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address.
• StreetSuffixFlag(optional): boolean
  Title: Direction Suffix

  Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address.
• StreetTypeFlag(optional): boolean
  Title: Street Suffix

  Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address.
• UnitNumberFlag(optional): boolean
  Title: Unit

  Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.

{
    "properties":{
        "Address2Flag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 2 should be part of the combination of address attributes used to identify a new address.",
            "title":"Address Line 2"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the options. Value is mandatory and is set programmatically.",
            "title":"Agency ID"
        },
        "CityFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute City should be part of the combination of address attributes used to identify a new address.",
            "title":"City"
        },
        "DisableMissingAddressFlag":{
            "type":"boolean",
            "description":"Indicates whether reference addresses in the database that are not in the address import file should be disabled. This option should only be used when the address import file contains a complete set of addresses for each parcel, including addresses with no changes.",
            "title":"Disable Addresses Not Found in Import File"
        },
        "DisableMissingDistrictFlag":{
            "type":"boolean",
            "description":"Indicates whether parcel district assignments in your database that are not in the district import file should be deleted. This option should only be used when the district import file contains a complete set of districts for each parcel, including districts with no changes.",
            "title":"Delete District Assignments Not Found in Import File"
        },
        "DisableMissingParcelOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether reference owners in your database that are not in the owner import file should be disabled. This option should only be used when the owner import file contains a complete set of owners for each parcel, including owners with no changes.",
            "title":"Disable Owners Not Found in Import File"
        },
        "FloorFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Floor should be part of the combination of address attributes used to identify a new address.",
            "title":"Floor"
        },
        "ImportAddressDistrictFlag":{
            "type":"boolean",
            "description":"Indicates whether an address district import file is to be processed by the Import Parcel Information process."
        },
        "ImportParcelAddressFlag":{
            "type":"boolean",
            "description":"Indicates whether a parcel address import file is to be processed by the Import Parcel Information process."
        },
        "ImportParcelDistrictFlag":{
            "type":"boolean",
            "description":"Indicates whether a parcel district import file is to be processed by the Import Parcel Information process."
        },
        "ImportParcelFlag":{
            "type":"boolean",
            "description":"Indicates whether a parcel import file is to be processed by the Import Parcel Information process."
        },
        "ImportParcelOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether a parcel owner import file is to be processed by the Import Parcel Information process."
        },
        "ImportParcelValueFlag":{
            "type":"boolean",
            "description":"Indicates whether a parcel value import file is to be processed by the Import Parcel Information process.",
            "title":"Value"
        },
        "MapAddressDistrict":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the address district import file."
        },
        "MapParcel":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel import file."
        },
        "MapParcelAddress":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel address import file."
        },
        "MapParcelDistrict":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel district import file."
        },
        "MapParcelOwner":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel owner import file."
        },
        "MapParcelValue":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates the CRM Import Manager File Import Mapping to be used by the Import Parcel Information process to import data from the parcel value import file."
        },
        "OptionalProcessEight":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessFive":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessFour":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessNine":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessOne":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessSeven":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessSix":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessThree":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OptionalProcessTwo":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of an additional process that is automatically run after successful completion of the Import Parcel Information process."
        },
        "OwnerAddress2Flag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the attribute Address Line 2 should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"Address Line 2"
        },
        "OwnerAddressFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Address Line 1 should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"Address Line 1"
        },
        "OwnerCityFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute City should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"City"
        },
        "OwnerNameFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Owner Name should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"Owner Name"
        },
        "OwnerPostalCodeFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Postal Code should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"Postal Code"
        },
        "OwnerStateFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute State should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"State"
        },
        "PostalCodeFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Postal Code should be part of the combination of address attributes used to identify a new address.",
            "title":"Postal Code"
        },
        "PreviewMode":{
            "type":"boolean",
            "description":"Indicates whether the Import Parcel Information process should allow the user to review a list of parcel reference data to be inactivated prior to performing the updates."
        },
        "RetireMissingParcelFlag":{
            "type":"boolean",
            "description":"Indicates whether reference parcels in the database that are not in the parcel import file should be retired. This option should only be used when the parcel import file contains a complete set of active parcels, including parcels with no changes.",
            "title":"Retire Parcels Not Found in Import File"
        },
        "SecondaryOwnerNameFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Secondary Owner should be part of the combination of parcel owner attributes used to identify a new parcel owner.",
            "title":"Secondary Owner"
        },
        "StateFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute State should be part of the combination of address attributes used to identify a new address.",
            "title":"State"
        },
        "StreetDirectionFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Direction Prefix should be part of the combination of address attributes used to identify a new address.",
            "title":"Direction Prefix"
        },
        "StreetNameFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Street Name should be part of the combination of address attributes used to identify a new address.",
            "title":"Street Name"
        },
        "StreetNumberFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Street Number should be part of the combination of address attributes used to identify a new address.",
            "title":"Street Number"
        },
        "StreetSuffixFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Direction Suffix should be part of the combination of address attributes used to identify a new address.",
            "title":"Direction Suffix"
        },
        "StreetTypeFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Street Suffix should be part of the combination of address attributes used to identify a new address.",
            "title":"Street Suffix"
        },
        "UnitNumberFlag":{
            "type":"boolean",
            "description":"Indicates whether the attribute Unit should be part of the combination of address attributes used to identify a new address.",
            "title":"Unit"
        },
        "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