Create a mobile offline unit of work
post
/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows
Request
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
-
ErrorMessage(required): string
Maximum Length:
1000
The error message response from processing the unit of work. -
MobileApplication(required): string
Maximum Length:
50
The mobile application name which created the unit of work. -
OfflineUowRecord: array
Mobile Offline Unit of Work Records
Title:
Mobile Offline Unit of Work Records
The mobile offline unit of work records resource is used to view, create, and update records belonging to a unit of work. The unit of work record contains information related to the unit of work content and the error response. -
Status(required): string
Maximum Length:
30
The resolution status for the issue seen in the unit of work. -
Type(required): string
Maximum Length:
30
The issue type seen in the unit of work. -
UowDescription: string
Maximum Length:
1000
The unit of work description containing information related to the application, inspection, inspector, and inspection location. -
UowId(required): string
Maximum Length:
100
The unit of work ID.
Nested Schema : Mobile Offline Unit of Work Records
Type:
array
Title:
Mobile Offline Unit of Work Records
The mobile offline unit of work records resource is used to view, create, and update records belonging to a unit of work. The unit of work record contains information related to the unit of work content and the error response.
Show Source
Nested Schema : publicSectorMobileOfflineUows-OfflineUowRecord-item-post-request
Type:
Show Source
object
-
CurrentErrorResponse: string
(byte)
The error response when processing the sync operation on the unit of work record.
-
MobileApplication: string
Maximum Length:
50
The mobile application name which created the unit of work associated with the record. -
StartSynchFrom: integer
(int32)
The sequence number of the request in the request list in the unit of work content indicating where to resume processing the sync operation for the unit of work.
-
UowContent: string
(byte)
The unit of work content containing a list of requests to be processed for the sync operation and the error response received.
-
UowId: string
Maximum Length:
100
The unit of work ID associated with the record. -
UowMovedDate: string
(date-time)
The date on which the unit of work record was moved.
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 : publicSectorMobileOfflineUows-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the unit of work. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the unit of work was created. -
ErrorMessage: string
Maximum Length:
1000
The error message response from processing the unit of work. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the unit of work was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the unit of work. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MobileApplication: string
Maximum Length:
50
The mobile application name which created the unit of work. -
OfflineUowRecord: array
Mobile Offline Unit of Work Records
Title:
Mobile Offline Unit of Work Records
The mobile offline unit of work records resource is used to view, create, and update records belonging to a unit of work. The unit of work record contains information related to the unit of work content and the error response. -
Status: string
Maximum Length:
30
The resolution status for the issue seen in the unit of work. -
Type: string
Maximum Length:
30
The issue type seen in the unit of work. -
UowDescription: string
Maximum Length:
1000
The unit of work description containing information related to the application, inspection, inspector, and inspection location. -
UowId: string
Maximum Length:
100
The unit of work ID.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Mobile Offline Unit of Work Records
Type:
array
Title:
Mobile Offline Unit of Work Records
The mobile offline unit of work records resource is used to view, create, and update records belonging to a unit of work. The unit of work record contains information related to the unit of work content and the error response.
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.
Nested Schema : publicSectorMobileOfflineUows-OfflineUowRecord-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the unit of work record. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the unit of work record was created. -
CurrentErrorResponse: string
(byte)
The error response when processing the sync operation on the unit of work record.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the unit of work record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the unit of work record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MobileApplication: string
Maximum Length:
50
The mobile application name which created the unit of work associated with the record. -
StartSynchFrom: integer
(int32)
The sequence number of the request in the request list in the unit of work content indicating where to resume processing the sync operation for the unit of work.
-
UowContent: string
(byte)
The unit of work content containing a list of requests to be processed for the sync operation and the error response received.
-
UowId: string
Maximum Length:
100
The unit of work ID associated with the record. -
UowMovedDate: string
(date-time)
The date on which the unit of work record was moved.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- OfflineUowRecord
-
Parameters:
- publicSectorMobileOfflineUowsUniqID:
$request.path.publicSectorMobileOfflineUowsUniqID
The mobile offline unit of work records resource is used to view, create, and update records belonging to a unit of work. The unit of work record contains information related to the unit of work content and the error response. - publicSectorMobileOfflineUowsUniqID: