Create a workflow reference
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/WorkflowReference
Request
Path Parameters
-
LnpRecordKey(required): integer(int64)
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The unique identifier for the public sector agency associated with the workflow reference. -
LnpRecordId: string
Maximum Length:
50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
The unique identifier of the record associated with the workflow process ID.
-
WfProcessId: integer
(int64)
The unique identifier for a workflow process ID.
-
WfProcName: string
Maximum Length:
1000
The process name for the workflow process. -
WfProcVersion: string
Maximum Length:
50
The version for the workflow process. -
WfProject: string
Maximum Length:
500
The project name for the workflow process. -
WfSpace: string
Maximum Length:
50
The unique space identifier for the workflow process. -
WfSpaceName: string
Maximum Length:
1000
The name of the space for the workflow process.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorRecords-WorkflowReference-item-response
Type:
Show Source
object
-
AgencyId: integer
Default Value:
1
The unique identifier for the public sector agency associated with the workflow reference. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the workflow reference. -
CreationDate: string
(date-time)
Read Only:
true
The date when the workflow reference was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the workflow reference was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the workflow reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Maximum Length:
50
The unique identifier for the application record. -
LnpRecordKey: integer
(int64)
The unique identifier of the record associated with the workflow process ID.
-
WfProcessId: integer
(int64)
The unique identifier for a workflow process ID.
-
WfProcName: string
Maximum Length:
1000
The process name for the workflow process. -
WfProcVersion: string
Maximum Length:
50
The version for the workflow process. -
WfProject: string
Maximum Length:
500
The project name for the workflow process. -
WfSpace: string
Maximum Length:
50
The unique space identifier for the workflow process. -
WfSpaceName: string
Maximum Length:
1000
The name of the space for the workflow process.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.