Jump to

• Request
• Response

Create synchronization errors

post

/fscmRestApi/resources/11.13.18.05/iotSyncResponses

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• failure: integer
  Total number of work orders that failed to synchronize with the Oracle Internet of Things Production Monitoring Cloud Service.
• items: array IoT Work Order Synchronization Responses
  Title: IoT Work Order Synchronization Responses

  The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.
• requestId: string
  Value that uniquely identifies the synchronization request.
• success: integer
  Total number of work orders that were successfully synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.
• total: integer
  Total number of work orders requested for synchronization.

{
    "type":"object",
    "properties":{
        "total":{
            "type":"integer",
            "description":"Total number of work orders requested for synchronization.",
            "nullable":true
        },
        "items":{
            "title":"IoT Work Order Synchronization Responses",
            "type":"array",
            "description":"The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.",
            "items":{
                "$ref":"#/components/schemas/iotSyncResponses-items-item-post-request"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Value that uniquely identifies the synchronization request.",
            "nullable":true,
            "x-queryable":false
        },
        "success":{
            "type":"integer",
            "description":"Total number of work orders that were successfully synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true
        },
        "failure":{
            "type":"integer",
            "description":"Total number of work orders that failed to synchronize with the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true
        }
    }
}

Nested Schema : IoT Work Order Synchronization Responses

Type: array

Title: IoT Work Order Synchronization Responses

The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.

Show Source

• Array of: object iotSyncResponses-items-item-post-request

{
    "title":"IoT Work Order Synchronization Responses",
    "type":"array",
    "description":"The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.",
    "items":{
        "$ref":"#/components/schemas/iotSyncResponses-items-item-post-request"
    }
}

Nested Schema : iotSyncResponses-items-item-post-request

Type: object

Show Source

• failureReason: string
  Title: Message Details

  Maximum Length: 4000

  Text of the error message received from the Oracle Internet of Things Production Monitoring Cloud Service.
• id: integer (int64)
  Title: Entity Internal Identifier

  Value that uniquely identifies the entity synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.
• status: number
  Title: Error Code

  Number that identifies the error, if any, received from the Oracle Internet of Things Production Monitoring Cloud Service.

{
    "type":"object",
    "properties":{
        "id":{
            "title":"Entity Internal Identifier",
            "type":"integer",
            "description":"Value that uniquely identifies the entity synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "failureReason":{
            "title":"Message Details",
            "maxLength":4000,
            "type":"string",
            "description":"Text of the error message received from the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true
        },
        "status":{
            "title":"Error Code",
            "type":"number",
            "description":"Number that identifies the error, if any, received from the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : iotSyncResponses-item-response

Type: object

Show Source

• failure: integer
  Total number of work orders that failed to synchronize with the Oracle Internet of Things Production Monitoring Cloud Service.
• items: array IoT Work Order Synchronization Responses
  Title: IoT Work Order Synchronization Responses

  The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• requestId: string
  Value that uniquely identifies the synchronization request.
• success: integer
  Total number of work orders that were successfully synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.
• total: integer
  Total number of work orders requested for synchronization.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "total":{
            "type":"integer",
            "description":"Total number of work orders requested for synchronization.",
            "nullable":true,
            "x-queryable":true
        },
        "items":{
            "title":"IoT Work Order Synchronization Responses",
            "type":"array",
            "description":"The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.",
            "items":{
                "$ref":"#/components/schemas/iotSyncResponses-items-item-response"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Value that uniquely identifies the synchronization request.",
            "nullable":true,
            "x-queryable":false
        },
        "success":{
            "type":"integer",
            "description":"Total number of work orders that were successfully synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true,
            "x-queryable":true
        },
        "failure":{
            "type":"integer",
            "description":"Total number of work orders that failed to synchronize with the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : IoT Work Order Synchronization Responses

Type: array

Title: IoT Work Order Synchronization Responses

The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.

Show Source

• Array of: object iotSyncResponses-items-item-response

{
    "title":"IoT Work Order Synchronization Responses",
    "type":"array",
    "description":"The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.",
    "items":{
        "$ref":"#/components/schemas/iotSyncResponses-items-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 : iotSyncResponses-items-item-response

Type: object

Show Source

• failureReason: string
  Title: Message Details

  Maximum Length: 4000

  Text of the error message received from the Oracle Internet of Things Production Monitoring Cloud Service.
• id: integer (int64)
  Title: Entity Internal Identifier

  Value that uniquely identifies the entity synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• status: number
  Title: Error Code

  Number that identifies the error, if any, received from the Oracle Internet of Things Production Monitoring Cloud Service.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "id":{
            "title":"Entity Internal Identifier",
            "type":"integer",
            "description":"Value that uniquely identifies the entity synchronized with the Oracle Internet of Things Production Monitoring Cloud Service.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "failureReason":{
            "title":"Message Details",
            "maxLength":4000,
            "type":"string",
            "description":"Text of the error message received from the Oracle Internet of Things Production Monitoring Cloud Service.",
            "nullable":true,
            "x-queryable":true
        },
        "status":{
            "title":"Error Code",
            "type":"number",
            "description":"Number that identifies the error, if any, received from the Oracle Internet of Things Production Monitoring Cloud Service.",
            "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 : 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."
        }
    }
}

Links

items

Operation: /fscmRestApi/resources/11.13.18.05/iotSyncResponses/{requestId}/child/items

Parameters:

• requestId: $request.path.requestId

The IoT Work Order Synchronization Responses resource includes the details of a work order synchronization request. The work order synchronization requests are created using the Manufacturing IoT Synchronization Responses resource.

Back to Top