Jump to

• Request
• Response

Get all project information

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectAPOSearches

Request

Query Parameters

• 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 the project that matches the primary key criteria.
    Finder Variables:
    • AddressKey; integer; The unique identifier of the project address.
    • AgencyId; integer; The identifier of the agency to which the project belongs.
    • ParcelKey; integer; The unique identifier of the project parcel.
    • ProjectCode; string; The unique identifier string of the project.
  • RowFinder: Finds the project that matces the specified keyword.
    Finder Variables:
    • value; string; The keyword used to find a project by project code, project name, project type, project summary, or meaning.
• 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.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The first line for the main address.
  • Address2; string; The second line for the address, if applicable.
  • Address3; string; The third line for the address, if applicable.
  • Address4; string; The fourth line for the address, if applicable.
  • AddressId; integer; The identifier of the parcel address.
  • AddressKey; integer; The unique identifier of the project address.
  • AgencyId; integer; The unique identifier of the public sector agency.
  • City; string; The name of the city as entered in the parcel address.
  • Country; string; The name of the country in the parcel address.
  • County; string; The name of the county in the parcel address.
  • CreationDate; string; The date when the project was created.
  • EndDate; string; The end date of the project.
  • LatitudeAdr; number; The latitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.
  • LatitudePar; number; The geographic location of the parcel that is north or south of the equator.
  • LongitudeAdr; number; The longitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.
  • LongitudePar; number; The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
  • Meaning; string; The meaning of the project status. The meaning can be active, inactive, on hold, completed, or canceled. The default value is active.
  • MunicipalityId; string; The municipality identifier if the parcel is not managed at the county level.
  • ParcelId; integer; The identifier of the project parcel.
  • ParcelIdEntered; string; The Assessor Parcel Number (APN) identifier as entered by the user.
  • ParcelKey; integer; The unique identifier of the project parcel.
  • PostalCode; string; The postal code as entered in the parcel address.
  • ProjectAdmin; integer; The project manager for the project.
  • ProjectAdminBizProfileId; integer; The identifier of the project manager business profile.
  • ProjectAdminProfileId; integer; The profile identifier of the project manager.
  • ProjectCode; string; The unique identifier of the project.
  • ProjectName; string; The name for the project.
  • ProjectSummary; string; A brief description of the project.
  • ProjectType; string; The type of project. The values are configured in the Project Type Setup page.
  • StartDate; string; The start date of the project.
  • State; string; The name of the state in the parcel address.
  • Status; string; The status of the project. The status values can be ORA_ACT, ORA_INA, ORA_ONH, ORA_COM, or ORA_CAN.
• 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".

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.

There's no request body for this operation.

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 : publicSectorProjectAPOSearches

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectAPOSearches-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Projects",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorProjectAPOSearches-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectAPOSearches-item-response"
    }
}

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 : publicSectorProjectAPOSearches-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first line for the main address.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second line for the address, if applicable.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third line for the address, if applicable.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line for the address, if applicable.
• AddressId: integer (int64)
  Read Only: true

  The identifier of the parcel address.
• AddressKey: integer (int64)
  Read Only: true

  The unique identifier of the project address.
• AgencyId: integer
  Read Only: true

  The unique identifier of the public sector agency.
• City: string
  Read Only: true

  Maximum Length: 60

  The name of the city as entered in the parcel address.
• Country: string
  Read Only: true

  Maximum Length: 60

  The name of the country in the parcel address.
• County: string
  Read Only: true

  Maximum Length: 60

  The name of the county in the parcel address.
• CreationDate: string (date-time)
  Read Only: true

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

  The end date of the project.
• LatitudeAdr: number
  Read Only: true

  The latitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.
• LatitudePar: number
  Read Only: true

  The geographic location of the parcel that is north or south of the equator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongitudeAdr: number
  Read Only: true

  The longitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.
• LongitudePar: number
  Read Only: true

  The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• Meaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the project status. The meaning can be active, inactive, on hold, completed, or canceled. The default value is active.
• MunicipalityId: string
  Read Only: true

  Maximum Length: 20

  The municipality identifier if the parcel is not managed at the county level.
• ParcelId: integer (int64)
  Read Only: true

  The identifier of the project parcel.
• ParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The Assessor Parcel Number (APN) identifier as entered by the user.
• ParcelKey: integer (int64)
  Read Only: true

  The unique identifier of the project parcel.
• PostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code as entered in the parcel address.
• ProjectAdmin: integer (int64)
  Read Only: true

  The project manager for the project.
• ProjectAdminBizProfileId: integer (int64)
  Read Only: true

  The identifier of the project manager business profile.
• ProjectAdminProfileId: integer (int64)
  Read Only: true

  The profile identifier of the project manager.
• ProjectCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier of the project.
• ProjectName: string
  Read Only: true

  Maximum Length: 50

  The name for the project.
• ProjectSummary: string
  Read Only: true

  Maximum Length: 500

  A brief description of the project.
• ProjectType: string
  Read Only: true

  Maximum Length: 50

  The type of project. The values are configured in the Project Type Setup page.
• StartDate: string (date-time)
  Read Only: true

  The start date of the project.
• State: string
  Read Only: true

  Maximum Length: 60

  The name of the state in the parcel address.
• Status: string
  Read Only: true

  Maximum Length: 7

  The status of the project. The status values can be ORA_ACT, ORA_INA, ORA_ONH, ORA_COM, or ORA_CAN.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the project was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatitudeAdr":{
            "type":"number",
            "description":"The latitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectAdmin":{
            "type":"integer",
            "description":"The project manager for the project.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code as entered in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the project.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LongitudePar":{
            "type":"number",
            "description":"The geographic location of the parcel address that is east or west of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line for the address, if applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The Assessor Parcel Number (APN) identifier as entered by the user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The unique identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "maxLength":"7",
            "type":"string",
            "description":"The status of the project. The status values can be ORA_ACT, ORA_INA, ORA_ONH, ORA_COM, or ORA_CAN.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectAdminBizProfileId":{
            "type":"integer",
            "description":"The identifier of the project manager business profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LongitudeAdr":{
            "type":"number",
            "description":"The longitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line for the address, if applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line for the address, if applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The unique identifier of the project address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line for the main address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city as entered in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectAdminProfileId":{
            "type":"integer",
            "description":"The profile identifier of the project manager.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MunicipalityId":{
            "maxLength":"20",
            "type":"string",
            "description":"The municipality identifier if the parcel is not managed at the county level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the project.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectSummary":{
            "maxLength":"500",
            "type":"string",
            "description":"A brief description of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatitudePar":{
            "type":"number",
            "description":"The geographic location of the parcel that is north or south of the equator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectType":{
            "maxLength":"50",
            "type":"string",
            "description":"The type of project. The values are configured in the Project Type Setup page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the country in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the project status. The meaning can be active, inactive, on hold, completed, or canceled. The default value is active.",
            "nullable":false,
            "readOnly":true,
            "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