REST API for Oracle Integration 3

Create or Update errorGroups for Trading Partner

post

/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups

Add a new or update existing errorGroup with the specified trading partner ID in project context.

Request

Path Parameters

projectId(required): string

Project identifier
tpId(required): string

Trading partner ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

errorGroupRs: ErrorGroupRs

{
    "type":"object",
    "properties":{
        "errorGroupRs":{
            "$ref":"#/components/schemas/ErrorGroupRs"
        }
    }
}

Nested Schema : ErrorGroupRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object ErrorGroupRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "usage":{
                    "type":"integer",
                    "format":"int32"
                },
                "desc":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "tradingPartnerId":{
                    "type":"string"
                },
                "errorCodes":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

object GenericRestRs
object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ErrorGroupRs-allOf[2]

Type: object

Show Source

createdDate: string
desc: string
errorCodes: array errorCodes
id: string
name: string
tradingPartnerId: string
updatedDate: string
usage: integer (int32)

{
    "type":"object",
    "properties":{
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "desc":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "tradingPartnerId":{
            "type":"string"
        },
        "errorCodes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

href: string
media-type: string
method: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : errorCodes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

201 Response

Successful operation

Root Schema : ErrorGroupRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object ErrorGroupRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "usage":{
                    "type":"integer",
                    "format":"int32"
                },
                "desc":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "tradingPartnerId":{
                    "type":"string"
                },
                "errorCodes":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

object GenericRestRs
object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ErrorGroupRs-allOf[2]

Type: object

Show Source

createdDate: string
desc: string
errorCodes: array errorCodes
id: string
name: string
tradingPartnerId: string
updatedDate: string
usage: integer (int32)

{
    "type":"object",
    "properties":{
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "desc":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "tradingPartnerId":{
            "type":"string"
        },
        "errorCodes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

href: string
media-type: string
method: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : errorCodes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

409 Response

Duplicate data error

412 Response

Pre-condition failure

500 Response

Server error