Update a workflow reference
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference/{WorkflowReferenceUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
LnpRecordKey: integer
The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
-
WorkflowReferenceUniqID: integer
This is the hash key of the attributes which make up the composite key--- LnpRecordKey and WfProcessId ---for the Workflow References resource and used to uniquely identify an instance of Workflow References. The client should not generate the hash key value. Instead, the client should query on the Workflow References collection resource with a filter on the primary key values in order to navigate to a specific instance of Workflow References.
For example: WorkflowReference?q=LnpRecordKey=<value1>;WfProcessId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorRecords-WorkflowReference-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the public sector agency associated with the workflow reference.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the workflow reference. -
CreationDate(optional):
string(date-time)
The date when the workflow reference was created.
-
LastUpdateDate(optional):
string(date-time)
The date when the workflow reference was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the workflow reference. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier for the application record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record associated with the workflow process ID.
-
WfProcessId(optional):
integer(int64)
The unique identifier for a workflow process ID.
-
WfProcName(optional):
string
Maximum Length:
1000
The process name for the workflow process. -
WfProcVersion(optional):
string
Maximum Length:
50
The version for the workflow process. -
WfProject(optional):
string
Maximum Length:
500
The project name for the workflow process. -
WfSpace(optional):
string
Maximum Length:
50
The unique space identifier for the workflow process. -
WfSpaceName(optional):
string
Maximum Length:
1000
The name of the space for the workflow process.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecords-WorkflowReference-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier for the public sector agency associated with the workflow reference.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the workflow reference. -
CreationDate(optional):
string(date-time)
The date when the workflow reference was created.
-
LastUpdateDate(optional):
string(date-time)
The date when the workflow reference was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the workflow reference. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Maximum Length:
50
The unique identifier for the application record. -
LnpRecordKey(optional):
integer(int64)
The unique identifier of the record associated with the workflow process ID.
-
WfProcessId(optional):
integer(int64)
The unique identifier for a workflow process ID.
-
WfProcName(optional):
string
Maximum Length:
1000
The process name for the workflow process. -
WfProcVersion(optional):
string
Maximum Length:
50
The version for the workflow process. -
WfProject(optional):
string
Maximum Length:
500
The project name for the workflow process. -
WfSpace(optional):
string
Maximum Length:
50
The unique space identifier for the workflow process. -
WfSpaceName(optional):
string
Maximum Length:
1000
The name of the space for the workflow process.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.