REST API for Oracle Public Sector Permitting and Licensing

Get all audits for a process

get

/fscmRestApi/resources/11.13.18.05/publicSectorProcessAudits

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 task that matches the specified primary key criteria.
  Finder Variables:
  - taskId; string; The unique identifier for a task.
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:
- assignedBy; string; The unique identifier of the person who has assigned the task.
- assignedByName; string; The display name of the person who has assigned this task.
- assignedDate; string; The date on which the task was assigned.
- assignedTo; string; The user ID of the person to which the task is assigned, or it can be the name of the role assigned to the swim lane in the process.
- assignedToName; string; The display name of the person to whom the task is assigned.
- completedDate; string; The date on which the task was completed.
- createdDate; string; The date on which the task was created.
- customStatus; string; The status assigned to a completed task after it is updated.
- dueDate; string; The date on which the task is due on.
- formMetadata; string; This field contains information about the web form from the process definition in Oracle Integration Cloud.
- metadataProperties; string; The metadata properties set on the process definition for a particular task.
- opaGenVersion; string; This indicates Oracle Process Automation (OPA) product generation to which the workflow process Instance belongs.
- opaProcessId; string; The unique identifier for the workflow process instance in Oracle Process Automation (OPA).
- priority; string; The priority of the task.
- processId; string; The unique identifier for the workflow process instance.
- sourceActivity; string; The identifier for the source activity as specified in Oracle Integration Cloud.
- status; string; The current status of the task.
- targetActivity; string; The identifier for the target activity as specified in Oracle Integration Cloud.
- taskId; string; The unique identifier for the workflow task.
- taskName; string; The name of the workflow task.
- updatedBy; string; The unique identifier of the person who has updated the task.
- updatedByName; string; The display name of the person who has updated the task.
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 : publicSectorProcessAudits

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object publicSectorProcessAudits-item-response

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

Type: object

Show Source

assignedBy: string

The unique identifier of the person who has assigned the task.
assignedByName: string

The display name of the person who has assigned this task.
assignedDate: string

Title: Assigned Date

The date on which the task was assigned.
assignedTo: string

The user ID of the person to which the task is assigned, or it can be the name of the role assigned to the swim lane in the process.
assignedToName: string

The display name of the person to whom the task is assigned.
completedDate: string

The date on which the task was completed.
createdDate: string

The date on which the task was created.
customStatus: string

The status assigned to a completed task after it is updated.
dueDate: string

Title: Due Date

The date on which the task is due on.
formMetadata: string

This field contains information about the web form from the process definition in Oracle Integration Cloud.
links: array Links

Title: Links

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

The metadata properties set on the process definition for a particular task.
opaGenVersion: string

This indicates Oracle Process Automation (OPA) product generation to which the workflow process Instance belongs.
opaProcessId: string

The unique identifier for the workflow process instance in Oracle Process Automation (OPA).
priority: string

The priority of the task.
ProcessAuditHistory: array History Process Audits

Title: History Process Audits

The history process audits resource is used to retrieve the history of a particular workflow task.
processId: string

The unique identifier for the workflow process instance.
sourceActivity: string

The identifier for the source activity as specified in Oracle Integration Cloud.
status: string

The current status of the task.
targetActivity: string

The identifier for the target activity as specified in Oracle Integration Cloud.
taskId: string

Title: Task ID

Maximum Length: 255

The unique identifier for the workflow task.
taskName: string

Title: Task Name

The name of the workflow task.
updatedBy: string

The unique identifier of the person who has updated the task.
updatedByName: string

The display name of the person who has updated the task.

{
    "type":"object",
    "properties":{
        "assignedDate":{
            "title":"Assigned Date",
            "type":"string",
            "description":"The date on which the task was assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "assignedBy":{
            "type":"string",
            "description":"The unique identifier of the person who has assigned the task.",
            "nullable":true,
            "x-queryable":true
        },
        "updatedBy":{
            "type":"string",
            "description":"The unique identifier of the person who has updated the task.",
            "nullable":true,
            "x-queryable":true
        },
        "formMetadata":{
            "type":"string",
            "description":"This field contains information about the web form from the process definition in Oracle Integration Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "targetActivity":{
            "type":"string",
            "description":"The identifier for the target activity as specified in Oracle Integration Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "assignedToName":{
            "type":"string",
            "description":"The display name of the person to whom the task is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "updatedByName":{
            "type":"string",
            "description":"The display name of the person who has updated the task.",
            "nullable":true,
            "x-queryable":true
        },
        "dueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date on which the task is due on.",
            "nullable":true,
            "x-queryable":true
        },
        "metadataProperties":{
            "type":"string",
            "description":"The metadata properties set on the process definition for a particular task.",
            "nullable":true,
            "x-queryable":true
        },
        "sourceActivity":{
            "type":"string",
            "description":"The identifier for the source activity as specified in Oracle Integration Cloud.",
            "nullable":true,
            "x-queryable":true
        },
        "priority":{
            "type":"string",
            "description":"The priority of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "assignedTo":{
            "type":"string",
            "description":"The user ID of the person to which the task is assigned, or it can be the name of the role assigned to the swim lane in the process.",
            "nullable":true,
            "x-queryable":true
        },
        "completedDate":{
            "type":"string",
            "description":"The date on which the task was completed.",
            "nullable":true,
            "x-queryable":true
        },
        "opaProcessId":{
            "type":"string",
            "description":"The unique identifier for the workflow process instance in Oracle Process Automation (OPA).",
            "nullable":true,
            "x-queryable":true
        },
        "createdDate":{
            "type":"string",
            "description":"The date on which the task was created.",
            "nullable":true,
            "x-queryable":true
        },
        "processId":{
            "type":"string",
            "description":"The unique identifier for the workflow process instance.",
            "nullable":true,
            "x-queryable":true
        },
        "opaGenVersion":{
            "type":"string",
            "description":"This indicates Oracle Process Automation (OPA) product generation to which the workflow process Instance belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "customStatus":{
            "type":"string",
            "description":"The status assigned to a completed task after it is updated.",
            "nullable":true,
            "x-queryable":true
        },
        "assignedByName":{
            "type":"string",
            "description":"The display name of the person who has assigned this task.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "taskName":{
            "title":"Task Name",
            "type":"string",
            "description":"The name of the workflow task.",
            "nullable":true,
            "x-queryable":true
        },
        "taskId":{
            "title":"Task ID",
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for the workflow task.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessAuditHistory":{
            "title":"History Process Audits",
            "type":"array",
            "description":"The history process audits resource is used to retrieve the history of a particular workflow task.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProcessAudits-ProcessAuditHistory-item-response"
            }
        },
        "status":{
            "type":"string",
            "description":"The current status of the task.",
            "nullable":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 : History Process Audits

Type: array

Title: History Process Audits

The history process audits resource is used to retrieve the history of a particular workflow task.

Show Source

Array of: object publicSectorProcessAudits-ProcessAuditHistory-item-response

{
    "title":"History Process Audits",
    "type":"array",
    "description":"The history process audits resource is used to retrieve the history of a particular workflow task.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProcessAudits-ProcessAuditHistory-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorProcessAudits-ProcessAuditHistory-item-response

Type: object

Show Source

actionName: string

Maximum Length: 255

A task may be assigned, acquired, reassigned or released, and eventually completed. This field holds the action that was taken on the task.
displayName: string

The name of the user who performed the action.
links: array Links

Title: Links

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

A task may be assigned, acquired, reassigned, or released, and eventually completed. This field holds the action that was taken on the task.
state: string

The current state of the task.
taskId: string

The unique identifier for the workflow task.
updatedDate: string

The date on which the action was taken.
userId: string

The unique identifier of the person who performed the action.

{
    "type":"object",
    "properties":{
        "reason":{
            "type":"string",
            "description":"A task may be assigned, acquired, reassigned, or released, and eventually completed. This field holds the action that was taken on the task.",
            "nullable":true,
            "x-queryable":true
        },
        "displayName":{
            "type":"string",
            "description":"The name of the user who performed the action.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "state":{
            "type":"string",
            "description":"The current state of the task.",
            "nullable":true,
            "x-queryable":true
        },
        "updatedDate":{
            "type":"string",
            "description":"The date on which the action was taken.",
            "nullable":true,
            "x-queryable":true
        },
        "userId":{
            "type":"string",
            "description":"The unique identifier of the person who performed the action.",
            "nullable":true,
            "x-queryable":true
        },
        "taskId":{
            "type":"string",
            "description":"The unique identifier for the workflow task.",
            "nullable":true,
            "x-queryable":true
        },
        "actionName":{
            "maxLength":"255",
            "type":"string",
            "description":"A task may be assigned, acquired, reassigned or released, and eventually completed. This field holds the action that was taken on the task.",
            "nullable":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"
    }
}