REST API for Oracle Public Sector Permitting and Licensing

Get all document categories

get

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories

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 document category that matches the primary key criteria specified.
  Finder Variables:
  - AgencyId; integer; The agency identifier of the public sector entity to which this document category applies.
  - DocumentCategory; string; The unique identifier of the document category.
- simpleSearchFinder: Finds the document category that matches the search criteria specified.
  Finder Variables:
  - value; string; The search value used to find a specific document category.
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:
- AcceptedEventFlag; boolean; Indicates whether an attachment is required referencing the document category when a permit is accepted. The default value is no.
- AgencyId; integer; The agency identifier of the public sector entity to which this document category applies.
- Category; string; The value that will be displayed for the document category related to an attachment.
- CompletedEventFlag; boolean; Indicates whether an attachment is required referencing the document category when a permit is completed. The default value is no.
- CreationDate; string; The date and time when the document category was created.
- Description; string; The long description value for the document category related to an attachment.
- DocumentCategory; string; The unique identifier for the document category.
- EnabledFlag; boolean; Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.
- FinalInspectionEventFlag; boolean; Indicates whether an attachment is required referencing the document category when a final inspection is added. The default value is no.
- IssuedEventFlag; boolean; Indicates whether an attachment is required referencing the document category when a permit is issued is required. The default value is no.
- LastUpdateDate; string; The date and time when the document category was last modified.
- SubmittedEventFlag; boolean; Indicates whether an attachment is required referencing the document category when a permit is submitted. The default value is no.
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 : publicSectorDocumentCategories

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object publicSectorDocumentCategories-item-response

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

Type: object

Show Source

AcceptedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document category when a permit is accepted. The default value is no.
AgencyId: integer

Title: Agency ID

Default Value: 1

The agency identifier of the public sector entity to which this document category applies.
Category: string

Title: Category

Maximum Length: 25

The value that will be displayed for the document category related to an attachment.
CompletedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document category when a permit is completed. The default value is no.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the document category was created.
Description: string

Title: Description

Maximum Length: 100

The long description value for the document category related to an attachment.
DocumentCategory: string

Title: Category ID

Maximum Length: 30

The unique identifier for the document category.
DocumentSubcategory: array Document Subcategories

Title: Document Subcategories

Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.
EnabledFlag: boolean

Title: Enabled

Maximum Length: 1

Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.
FinalInspectionEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document category when a final inspection is added. The default value is no.
IssuedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document category when a permit is issued is required. The default value is no.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the document category was last modified.
links: array Links

Title: Links

The link relations associated with the resource instance.
SubmittedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document category when a permit is submitted. The default value is no.
UserAssistanceText: string (byte)

The required documents information for document categories.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the document category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentSubcategory":{
            "title":"Document Subcategories",
            "type":"array",
            "description":"Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDocumentCategories-DocumentSubcategory-item-response"
            }
        },
        "Category":{
            "title":"Category",
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for the document category related to an attachment.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document category applies.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "FinalInspectionEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document category when a final inspection is added. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "IssuedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document category when a permit is issued  is required. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AcceptedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document category when a permit is accepted. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SubmittedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document category when a permit is submitted. The default value is no.",
            "nullable":false,
            "default":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":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the document category is enabled or not available for selection in attachments. If true, the document category is enabled and is a valid value that can be selected as a document category. If false, the document category is not a valid value and can't be selected as a document category. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "CompletedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document category when a permit is completed. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "UserAssistanceText":{
            "type":"string",
            "description":"The required documents information for document categories.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the document category was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Document Subcategories

Type: array

Title: Document Subcategories

Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.

Show Source

Array of: object publicSectorDocumentCategories-DocumentSubcategory-item-response

{
    "title":"Document Subcategories",
    "type":"array",
    "description":"Use document subcategories resource to view, update, create, and delete document subcategories. A document subcategory is used to specify the subcategory of a document category for an uploaded attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDocumentCategories-DocumentSubcategory-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 : publicSectorDocumentCategories-DocumentSubcategory-item-response

Type: object

Show Source

AcceptedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document subcategory when a permit is accepted. The default value is no.
AgencyId: integer

Title: Agency ID

Default Value: 1

The agency identifier of the public sector entity to which this document subcategory applies.
CompletedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document subcategory when a permit is completed. The default value is no.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the document subcategory was created.
Description: string

Title: Description

Maximum Length: 100

The long description value for the document subcategory related to an attachment.
DocumentCategory: string

Title: Category ID

Maximum Length: 30

The unique identifier for the document category.
DocumentSubcategory: string

Title: Subcategory ID

Maximum Length: 30

The unique identifier for the document subcategory.
EnabledFlag: boolean

Title: Enabled

Maximum Length: 1

Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.
FinalInspectionEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document subcategory when a final inspection is added. The default value is no.
IssuedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document subcategory when a permit is issued is required. The default value is no.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the document subcategory was last modified.
links: array Links

Title: Links

The link relations associated with the resource instance.
Subcategory: string

Title: Subcategory

Maximum Length: 25

The value that will be displayed for the document subcategory related to an attachment.
SubmittedEventFlag: boolean

Maximum Length: 1

Default Value: false

Indicates whether an attachment is required referencing the document subcategory when a permit is submitted. The default value is no.
UserAssistanceText: string (byte)

The required documents information for document subcategories.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the document subcategory was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentSubcategory":{
            "title":"Subcategory ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for the document subcategory related to an attachment.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document subcategory applies.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "FinalInspectionEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document subcategory when a final inspection is added. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "IssuedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document subcategory when a permit is issued  is required. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AcceptedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document subcategory when a permit is accepted. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for the document subcategory related to an attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "SubmittedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document subcategory when a permit is submitted. The default value is no.",
            "nullable":false,
            "default":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":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "CompletedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment is required referencing the document subcategory when a permit is completed. The default value is no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "UserAssistanceText":{
            "type":"string",
            "description":"The required documents information for document subcategories.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the document subcategory 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."
        }
    }
}