Jump to

• Request
• Response

Update Sync Request

patch

/rest/apis/common/sync/syncRequest/{syncRequestId}

This operation is used when an external system responds to a Sync Request. If the exception messages are provided, they are populated and the BO is transitioned to the exception state. If no exception messages are provided, the BO is transitioned to the default next state.

Request

Path Parameters

• syncRequestId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• F1-UpdateSyncRequest: object F1-UpdateSyncRequest

{
    "type":"object",
    "properties":{
        "F1-UpdateSyncRequest":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "maxLength":"14",
                    "description":"Sync Request Id"
                },
                "exceptionInfo":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Sequence"
                            },
                            "messageCategory":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Message Category"
                            },
                            "messageNumber":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Message Number"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Comments"
                            },
                            "messageParameters":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "parameterSequence":{
                                            "type":"number",
                                            "maximum":"999",
                                            "minimum":"-999",
                                            "description":"Sequence"
                                        },
                                        "messageParameterValue":{
                                            "type":"string",
                                            "maxLength":"2000",
                                            "description":"Message Parameter Value"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "externalIds":{
                    "type":"object",
                    "properties":{
                        "entityIdList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "entity":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Entity"
                                    },
                                    "externalPk1":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 1"
                                    },
                                    "externalPk2":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 2"
                                    },
                                    "externalPk3":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 3"
                                    },
                                    "externalPk4":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 4"
                                    },
                                    "externalPk5":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 5"
                                    }
                                }
                            }
                        }
                    }
                },
                "hasError":{
                    "type":"boolean",
                    "description":"Has Error"
                }
            }
        }
    }
}

Nested Schema : F1-UpdateSyncRequest

Type: object

Show Source

• exceptionInfo: array exceptionInfo
• externalIds: object externalIds
• hasError: boolean
  Has Error
• syncRequestId: string
  Maximum Length: 14

  Sync Request Id

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "maxLength":"14",
            "description":"Sync Request Id"
        },
        "exceptionInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence"
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Message Category"
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Message Number"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Comments"
                    },
                    "messageParameters":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "parameterSequence":{
                                    "type":"number",
                                    "maximum":"999",
                                    "minimum":"-999",
                                    "description":"Sequence"
                                },
                                "messageParameterValue":{
                                    "type":"string",
                                    "maxLength":"2000",
                                    "description":"Message Parameter Value"
                                }
                            }
                        }
                    }
                }
            }
        },
        "externalIds":{
            "type":"object",
            "properties":{
                "entityIdList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "entity":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Entity"
                            },
                            "externalPk1":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 1"
                            },
                            "externalPk2":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 2"
                            },
                            "externalPk3":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 3"
                            },
                            "externalPk4":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 4"
                            },
                            "externalPk5":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 5"
                            }
                        }
                    }
                }
            }
        },
        "hasError":{
            "type":"boolean",
            "description":"Has Error"
        }
    }
}

Nested Schema : exceptionInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence"
            },
            "messageCategory":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Message Category"
            },
            "messageNumber":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Message Number"
            },
            "comments":{
                "type":"string",
                "maxLength":"254",
                "description":"Comments"
            },
            "messageParameters":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "parameterSequence":{
                            "type":"number",
                            "maximum":"999",
                            "minimum":"-999",
                            "description":"Sequence"
                        },
                        "messageParameterValue":{
                            "type":"string",
                            "maxLength":"2000",
                            "description":"Message Parameter Value"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : externalIds

Type: object

Show Source

• entityIdList: array entityIdList

{
    "type":"object",
    "properties":{
        "entityIdList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entity":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Entity"
                    },
                    "externalPk1":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 1"
                    },
                    "externalPk2":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 2"
                    },
                    "externalPk3":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 3"
                    },
                    "externalPk4":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 4"
                    },
                    "externalPk5":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 5"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number
• messageParameters: array messageParameters
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence"
        },
        "messageCategory":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number"
        },
        "comments":{
            "type":"string",
            "maxLength":"254",
            "description":"Comments"
        },
        "messageParameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterSequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence"
                    },
                    "messageParameterValue":{
                        "type":"string",
                        "maxLength":"2000",
                        "description":"Message Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : messageParameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterSequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence"
            },
            "messageParameterValue":{
                "type":"string",
                "maxLength":"2000",
                "description":"Message Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• messageParameterValue: string
  Maximum Length: 2000

  Message Parameter Value
• parameterSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "parameterSequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence"
        },
        "messageParameterValue":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter Value"
        }
    }
}

Nested Schema : entityIdList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entity":{
                "type":"string",
                "maxLength":"60",
                "description":"Entity"
            },
            "externalPk1":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 1"
            },
            "externalPk2":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 2"
            },
            "externalPk3":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 3"
            },
            "externalPk4":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 4"
            },
            "externalPk5":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 5"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entity: string
  Maximum Length: 60

  Entity
• externalPk1: string
  Maximum Length: 60

  External PK Val 1
• externalPk2: string
  Maximum Length: 60

  External PK Val 2
• externalPk3: string
  Maximum Length: 60

  External PK Val 3
• externalPk4: string
  Maximum Length: 60

  External PK Val 4
• externalPk5: string
  Maximum Length: 60

  External PK Val 5

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"string",
            "maxLength":"60",
            "description":"Entity"
        },
        "externalPk1":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 1"
        },
        "externalPk2":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 2"
        },
        "externalPk3":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 3"
        },
        "externalPk4":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 4"
        },
        "externalPk5":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 5"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• F1-UpdateSyncRequest: object F1-UpdateSyncRequest

{
    "type":"object",
    "properties":{
        "F1-UpdateSyncRequest":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "maxLength":"14",
                    "description":"Sync Request Id"
                },
                "exceptionInfo":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Sequence"
                            },
                            "messageCategory":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Message Category"
                            },
                            "messageNumber":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Message Number"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Comments"
                            },
                            "messageParameters":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "parameterSequence":{
                                            "type":"number",
                                            "maximum":"999",
                                            "minimum":"-999",
                                            "description":"Sequence"
                                        },
                                        "messageParameterValue":{
                                            "type":"string",
                                            "maxLength":"2000",
                                            "description":"Message Parameter Value"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "externalIds":{
                    "type":"object",
                    "properties":{
                        "entityIdList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "entity":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Entity"
                                    },
                                    "externalPk1":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 1"
                                    },
                                    "externalPk2":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 2"
                                    },
                                    "externalPk3":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 3"
                                    },
                                    "externalPk4":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 4"
                                    },
                                    "externalPk5":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 5"
                                    }
                                }
                            }
                        }
                    }
                },
                "hasError":{
                    "type":"boolean",
                    "description":"Has Error"
                }
            }
        }
    }
}

Nested Schema : F1-UpdateSyncRequest

Type: object

Show Source

• exceptionInfo: array exceptionInfo
• externalIds: object externalIds
• hasError: boolean
  Has Error
• syncRequestId: string
  Maximum Length: 14

  Sync Request Id

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "maxLength":"14",
            "description":"Sync Request Id"
        },
        "exceptionInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence"
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Message Category"
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Message Number"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Comments"
                    },
                    "messageParameters":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "parameterSequence":{
                                    "type":"number",
                                    "maximum":"999",
                                    "minimum":"-999",
                                    "description":"Sequence"
                                },
                                "messageParameterValue":{
                                    "type":"string",
                                    "maxLength":"2000",
                                    "description":"Message Parameter Value"
                                }
                            }
                        }
                    }
                }
            }
        },
        "externalIds":{
            "type":"object",
            "properties":{
                "entityIdList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "entity":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Entity"
                            },
                            "externalPk1":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 1"
                            },
                            "externalPk2":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 2"
                            },
                            "externalPk3":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 3"
                            },
                            "externalPk4":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 4"
                            },
                            "externalPk5":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 5"
                            }
                        }
                    }
                }
            }
        },
        "hasError":{
            "type":"boolean",
            "description":"Has Error"
        }
    }
}

Nested Schema : exceptionInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence"
            },
            "messageCategory":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Message Category"
            },
            "messageNumber":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Message Number"
            },
            "comments":{
                "type":"string",
                "maxLength":"254",
                "description":"Comments"
            },
            "messageParameters":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "parameterSequence":{
                            "type":"number",
                            "maximum":"999",
                            "minimum":"-999",
                            "description":"Sequence"
                        },
                        "messageParameterValue":{
                            "type":"string",
                            "maxLength":"2000",
                            "description":"Message Parameter Value"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : externalIds

Type: object

Show Source

• entityIdList: array entityIdList

{
    "type":"object",
    "properties":{
        "entityIdList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entity":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Entity"
                    },
                    "externalPk1":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 1"
                    },
                    "externalPk2":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 2"
                    },
                    "externalPk3":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 3"
                    },
                    "externalPk4":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 4"
                    },
                    "externalPk5":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 5"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number
• messageParameters: array messageParameters
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence"
        },
        "messageCategory":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number"
        },
        "comments":{
            "type":"string",
            "maxLength":"254",
            "description":"Comments"
        },
        "messageParameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterSequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence"
                    },
                    "messageParameterValue":{
                        "type":"string",
                        "maxLength":"2000",
                        "description":"Message Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : messageParameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterSequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence"
            },
            "messageParameterValue":{
                "type":"string",
                "maxLength":"2000",
                "description":"Message Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• messageParameterValue: string
  Maximum Length: 2000

  Message Parameter Value
• parameterSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "parameterSequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence"
        },
        "messageParameterValue":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter Value"
        }
    }
}

Nested Schema : entityIdList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entity":{
                "type":"string",
                "maxLength":"60",
                "description":"Entity"
            },
            "externalPk1":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 1"
            },
            "externalPk2":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 2"
            },
            "externalPk3":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 3"
            },
            "externalPk4":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 4"
            },
            "externalPk5":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 5"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entity: string
  Maximum Length: 60

  Entity
• externalPk1: string
  Maximum Length: 60

  External PK Val 1
• externalPk2: string
  Maximum Length: 60

  External PK Val 2
• externalPk3: string
  Maximum Length: 60

  External PK Val 3
• externalPk4: string
  Maximum Length: 60

  External PK Val 4
• externalPk5: string
  Maximum Length: 60

  External PK Val 5

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"string",
            "maxLength":"60",
            "description":"Entity"
        },
        "externalPk1":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 1"
        },
        "externalPk2":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 2"
        },
        "externalPk3":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 3"
        },
        "externalPk4":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 4"
        },
        "externalPk5":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 5"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : UPDATE_response

Type: object

Show Source

• F1-UpdateSyncRequest: object F1-UpdateSyncRequest

{
    "type":"object",
    "properties":{
        "F1-UpdateSyncRequest":{
            "type":"object",
            "properties":{
                "syncRequestId":{
                    "type":"string",
                    "maxLength":"14",
                    "description":"Sync Request Id"
                },
                "exceptionInfo":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Sequence"
                            },
                            "messageCategory":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Message Category"
                            },
                            "messageNumber":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"Message Number"
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":"254",
                                "description":"Comments"
                            },
                            "messageParameters":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "parameterSequence":{
                                            "type":"number",
                                            "maximum":"999",
                                            "minimum":"-999",
                                            "description":"Sequence"
                                        },
                                        "messageParameterValue":{
                                            "type":"string",
                                            "maxLength":"2000",
                                            "description":"Message Parameter Value"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                "externalIds":{
                    "type":"object",
                    "properties":{
                        "entityIdList":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "entity":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"Entity"
                                    },
                                    "externalPk1":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 1"
                                    },
                                    "externalPk2":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 2"
                                    },
                                    "externalPk3":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 3"
                                    },
                                    "externalPk4":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 4"
                                    },
                                    "externalPk5":{
                                        "type":"string",
                                        "maxLength":"60",
                                        "description":"External PK Val 5"
                                    }
                                }
                            }
                        }
                    }
                },
                "hasError":{
                    "type":"boolean",
                    "description":"Has Error"
                }
            }
        }
    }
}

Nested Schema : F1-UpdateSyncRequest

Type: object

Show Source

• exceptionInfo: array exceptionInfo
• externalIds: object externalIds
• hasError: boolean
  Has Error
• syncRequestId: string
  Maximum Length: 14

  Sync Request Id

{
    "type":"object",
    "properties":{
        "syncRequestId":{
            "type":"string",
            "maxLength":"14",
            "description":"Sync Request Id"
        },
        "exceptionInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence"
                    },
                    "messageCategory":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Message Category"
                    },
                    "messageNumber":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"Message Number"
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Comments"
                    },
                    "messageParameters":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "parameterSequence":{
                                    "type":"number",
                                    "maximum":"999",
                                    "minimum":"-999",
                                    "description":"Sequence"
                                },
                                "messageParameterValue":{
                                    "type":"string",
                                    "maxLength":"2000",
                                    "description":"Message Parameter Value"
                                }
                            }
                        }
                    }
                }
            }
        },
        "externalIds":{
            "type":"object",
            "properties":{
                "entityIdList":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "entity":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"Entity"
                            },
                            "externalPk1":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 1"
                            },
                            "externalPk2":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 2"
                            },
                            "externalPk3":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 3"
                            },
                            "externalPk4":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 4"
                            },
                            "externalPk5":{
                                "type":"string",
                                "maxLength":"60",
                                "description":"External PK Val 5"
                            }
                        }
                    }
                }
            }
        },
        "hasError":{
            "type":"boolean",
            "description":"Has Error"
        }
    }
}

Nested Schema : exceptionInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence"
            },
            "messageCategory":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Message Category"
            },
            "messageNumber":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"Message Number"
            },
            "comments":{
                "type":"string",
                "maxLength":"254",
                "description":"Comments"
            },
            "messageParameters":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "parameterSequence":{
                            "type":"number",
                            "maximum":"999",
                            "minimum":"-999",
                            "description":"Sequence"
                        },
                        "messageParameterValue":{
                            "type":"string",
                            "maxLength":"2000",
                            "description":"Message Parameter Value"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : externalIds

Type: object

Show Source

• entityIdList: array entityIdList

{
    "type":"object",
    "properties":{
        "entityIdList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "entity":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Entity"
                    },
                    "externalPk1":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 1"
                    },
                    "externalPk2":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 2"
                    },
                    "externalPk3":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 3"
                    },
                    "externalPk4":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 4"
                    },
                    "externalPk5":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"External PK Val 5"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• comments: string
  Maximum Length: 254

  Comments
• messageCategory: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Category
• messageNumber: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number
• messageParameters: array messageParameters
• sequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence"
        },
        "messageCategory":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Category"
        },
        "messageNumber":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number"
        },
        "comments":{
            "type":"string",
            "maxLength":"254",
            "description":"Comments"
        },
        "messageParameters":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "parameterSequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence"
                    },
                    "messageParameterValue":{
                        "type":"string",
                        "maxLength":"2000",
                        "description":"Message Parameter Value"
                    }
                }
            }
        }
    }
}

Nested Schema : messageParameters

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "parameterSequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence"
            },
            "messageParameterValue":{
                "type":"string",
                "maxLength":"2000",
                "description":"Message Parameter Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• messageParameterValue: string
  Maximum Length: 2000

  Message Parameter Value
• parameterSequence: number
  Minimum Value: -999

  Maximum Value: 999

  Sequence

{
    "type":"object",
    "properties":{
        "parameterSequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence"
        },
        "messageParameterValue":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter Value"
        }
    }
}

Nested Schema : entityIdList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "entity":{
                "type":"string",
                "maxLength":"60",
                "description":"Entity"
            },
            "externalPk1":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 1"
            },
            "externalPk2":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 2"
            },
            "externalPk3":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 3"
            },
            "externalPk4":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 4"
            },
            "externalPk5":{
                "type":"string",
                "maxLength":"60",
                "description":"External PK Val 5"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• entity: string
  Maximum Length: 60

  Entity
• externalPk1: string
  Maximum Length: 60

  External PK Val 1
• externalPk2: string
  Maximum Length: 60

  External PK Val 2
• externalPk3: string
  Maximum Length: 60

  External PK Val 3
• externalPk4: string
  Maximum Length: 60

  External PK Val 4
• externalPk5: string
  Maximum Length: 60

  External PK Val 5

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"string",
            "maxLength":"60",
            "description":"Entity"
        },
        "externalPk1":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 1"
        },
        "externalPk2":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 2"
        },
        "externalPk3":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 3"
        },
        "externalPk4":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 4"
        },
        "externalPk5":{
            "type":"string",
            "maxLength":"60",
            "description":"External PK Val 5"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":"60",
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":"9999",
            "minimum":"0",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":"60",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":"60",
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":"60",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":"60",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":"60",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top