Jump to

• Request
• Response

Update a mobile offline unit of work

patch

/fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}

Request

Path Parameters

• publicSectorMobileOfflineUowsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- MobileApplication and UowId ---for the Mobile Offline Work Units resource and used to uniquely identify an instance of Mobile Offline Work Units. The client should not generate the hash key value. Instead, the client should query on the Mobile Offline Work Units collection resource with a filter on the primary key values in order to navigate to a specific instance of Mobile Offline Work Units.
  
  For example: publicSectorMobileOfflineUows?q=MobileApplication=<value1>;UowId=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ErrorMessage: string
  Maximum Length: 1000

  The error message response from processing the unit of work.
• 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.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The resolution status for the issue seen in the unit of work.",
            "nullable":false
        },
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"The issue type seen in the unit of work.",
            "nullable":false
        },
        "MobileApplication":{
            "maxLength":"50",
            "type":"string",
            "description":"The mobile application name which created the unit of work.",
            "nullable":false
        },
        "OfflineUowRecord":{
            "title":"Mobile Offline Unit of Work Records",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMobileOfflineUows-OfflineUowRecord-item-patch-request"
            }
        },
        "UowDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The unit of work description containing information related to the application, inspection, inspector, and inspection location.",
            "nullable":true
        },
        "UowId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unit of work ID.",
            "nullable":false
        },
        "ErrorMessage":{
            "maxLength":"1000",
            "type":"string",
            "description":"The error message response from processing the unit of work.",
            "nullable":false
        }
    }
}

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

• Array of: object publicSectorMobileOfflineUows-OfflineUowRecord-item-patch-request

{
    "title":"Mobile Offline Unit of Work Records",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMobileOfflineUows-OfflineUowRecord-item-patch-request"
    }
}

Nested Schema : publicSectorMobileOfflineUows-OfflineUowRecord-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MobileApplication":{
            "maxLength":"50",
            "type":"string",
            "description":"The mobile application name which created the unit of work associated with the record.",
            "nullable":false
        },
        "UowContent":{
            "type":"string",
            "description":"The unit of work content containing a list of requests to be processed for the sync operation and the error response received.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StartSynchFrom":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "UowId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unit of work ID associated with the record.",
            "nullable":false
        },
        "CurrentErrorResponse":{
            "type":"string",
            "description":"The error response when processing the sync operation on the unit of work record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "UowMovedDate":{
            "type":"string",
            "description":"The date on which the unit of work record was moved.",
            "format":"date-time",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorMobileOfflineUows-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the unit of work.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The resolution status for the issue seen in the unit of work.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the unit of work was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"The issue type seen in the unit of work.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the unit of work.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MobileApplication":{
            "maxLength":"50",
            "type":"string",
            "description":"The mobile application name which created the unit of work.",
            "nullable":false,
            "x-queryable":true
        },
        "OfflineUowRecord":{
            "title":"Mobile Offline Unit of Work Records",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorMobileOfflineUows-OfflineUowRecord-item-response"
            }
        },
        "UowDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The unit of work description containing information related to the application, inspection, inspector, and inspection location.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UowId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unit of work ID.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":"1000",
            "type":"string",
            "description":"The error message response from processing the unit of work.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the unit of work was last updated.",
            "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 : 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

• Array of: object publicSectorMobileOfflineUows-OfflineUowRecord-item-response

{
    "title":"Mobile Offline Unit of Work Records",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorMobileOfflineUows-OfflineUowRecord-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 : publicSectorMobileOfflineUows-OfflineUowRecord-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the unit of work record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the unit of work record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the unit of work record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MobileApplication":{
            "maxLength":"50",
            "type":"string",
            "description":"The mobile application name which created the unit of work associated with the record.",
            "nullable":false,
            "x-queryable":true
        },
        "UowContent":{
            "type":"string",
            "description":"The unit of work content containing a list of requests to be processed for the sync operation and the error response received.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StartSynchFrom":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UowId":{
            "maxLength":"100",
            "type":"string",
            "description":"The unit of work ID associated with the record.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the unit of work record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentErrorResponse":{
            "type":"string",
            "description":"The error response when processing the sync operation on the unit of work record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "UowMovedDate":{
            "type":"string",
            "description":"The date on which the unit of work record was moved.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Links

OfflineUowRecord

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMobileOfflineUows/{publicSectorMobileOfflineUowsUniqID}/child/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.

Back to Top