REST API for Oracle Public Sector Permitting and Licensing

Get all plan review decisions

get

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewDecisions

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 plan review decision that matches the primary key criteria specified.
  Finder Variables:
  - AgencyId; integer; The agency identifier of the public sector entity to which this plan review decision applies.
  - SystemStatus; string; The unique identifier of the plan review decision.
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:
- AgencyId; integer; The agency identifier of the public sector entity to which this plan review decision applies.
- CreationDate; string; The date and time when the plan review decision was created.
- DecisionStatus; string; The name of the decision status.
- DeletedFlag; boolean; Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
- Description; string; The value that will be displayed for a permit plan review decision in a plan review cycle.
- DescriptionPz; string; The value that will be displayed for a planning plan review decision in a plan review cycle.
- EnabledFlag; boolean; Indicates whether the decision status is enabled for permit plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
- EnabledPzFlag; boolean; Indicates whether the decision status is enabled for planning plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
- LastUpdateDate; string; The date and time when the plan review decision was last modified.
- SeedDataLock; integer; Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
- SystemStatus; string; The unique identifier for the plan review decision.
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.

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.

Root Schema : publicSectorPlanReviewDecisions

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/publicSectorPlanReviewDecisions-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Permits",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object publicSectorPlanReviewDecisions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPlanReviewDecisions-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 : publicSectorPlanReviewDecisions-item-response

Type: object

Show Source

AgencyId: integer (int32)

Default Value: 1

The agency identifier of the public sector entity to which this plan review decision applies.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the plan review decision was created.
DecisionStatus: string

Title: Decision Status

Maximum Length: 35

The name of the decision status.
DeletedFlag: boolean

Maximum Length: 1

Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
Description: string

Title: Permit Decision Description

Maximum Length: 100

The value that will be displayed for a permit plan review decision in a plan review cycle.
DescriptionPz: string

Title: Planning Decision Description

Maximum Length: 100

The value that will be displayed for a planning plan review decision in a plan review cycle.
EnabledFlag: boolean

Title: Permit Decision Enabled

Maximum Length: 1

Indicates whether the decision status is enabled for permit plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
EnabledPzFlag: boolean

Title: Planning Decision Enabled

Maximum Length: 1

Default Value: false

Indicates whether the decision status is enabled for planning plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true. This attribute can only be changed for a decision status of Approved with Comments.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the plan review decision was last modified.
links: array Links

Title: Links

The link relations associated with the resource instance.
SeedDataLock: integer (int32)

Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
SystemStatus: string

Title: System Status

Maximum Length: 15

The unique identifier for the plan review decision.

{
    "type":"object",
    "properties":{
        "SystemStatus":{
            "title":"System Status",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier for the plan review decision.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the plan review decision was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DecisionStatus":{
            "title":"Decision Status",
            "maxLength":"35",
            "type":"string",
            "description":"The name of the decision status.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Permit Decision Description",
            "maxLength":"100",
            "type":"string",
            "description":"The value that will be displayed for a permit plan review decision in a plan review cycle.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan review decision applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DescriptionPz":{
            "title":"Planning Decision Description",
            "maxLength":"100",
            "type":"string",
            "description":"The value that will be displayed for a planning plan review decision in a plan review cycle.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data for the decision is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the decision seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Permit Decision Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the decision status is enabled for permit plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true.  This attribute can only be changed for a decision status of Approved with Comments.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledPzFlag":{
            "title":"Planning Decision Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the decision status is enabled for planning plan review decisions. If true, the decision is enabled and is a valid value that can be selected as a decision. If false, the decision is not a valid value that can be selected as a decision. The default value is true.  This attribute can only be changed for a decision status of Approved with Comments.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the plan review decision was last modified.",
            "format":"date-time",
            "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."
        }
    }
}