REST API for Oracle Integration 3

Delete an Outbound Agreement

delete

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

Deletes an outbound agreement with the specified trading partner ID and outbound agreement ID in project context.

Request

Path Parameters

agrId(required): string

Trading partner outbound agreement ID.
projectId(required): string

Project identifier
tpId(required): string

Trading partner ID.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : OutboundAgrRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object OutboundAgrRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "docStd":{
                    "type":"string"
                },
                "docVersion":{
                    "type":"string"
                },
                "docTxId":{
                    "type":"string"
                },
                "docDef":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "lastDeployed":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "tpIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "hostIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/HostIdentifierRs"
                    }
                },
                "transportName":{
                    "type":"string"
                },
                "params":{
                    "$ref":"#/components/schemas/OutboundAgr.Params"
                },
                "transportId":{
                    "type":"string"
                },
                "tpmVerson":{
                    "type":"string"
                },
                "batchEnabled":{
                    "type":"string"
                },
                "scheduleOperation":{
                    "type":"string"
                },
                "schedule":{
                    "$ref":"#/components/schemas/OutboundAgr.Schedule"
                }
            }
        }
    ]
}

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 : OutboundAgrRs-allOf[2]

Type: object

Show Source

batchEnabled: string
createdDate: string
desc: string
docDef: string
docId: string
docStd: string
docTxId: string
docVersion: string
hostIdentifiersRef: array hostIdentifiersRef
id: string
lastDeployed: string
name: string
params: object OutboundAgr.Params
schedule: object OutboundAgr.Schedule
scheduleOperation: string
status: string
tpIdentifiersRef: array tpIdentifiersRef
tpmVerson: string
transportId: string
transportName: string
updatedDate: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "docStd":{
            "type":"string"
        },
        "docVersion":{
            "type":"string"
        },
        "docTxId":{
            "type":"string"
        },
        "docDef":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HostIdentifierRs"
            }
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/components/schemas/OutboundAgr.Params"
        },
        "transportId":{
            "type":"string"
        },
        "tpmVerson":{
            "type":"string"
        },
        "batchEnabled":{
            "type":"string"
        },
        "scheduleOperation":{
            "type":"string"
        },
        "schedule":{
            "$ref":"#/components/schemas/OutboundAgr.Schedule"
        }
    }
}

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 : hostIdentifiersRef

Type: array

Show Source

Array of: HostIdentifierRs

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

Nested Schema : OutboundAgr.Params

Type: object

Show Source

acceptGroup: string
acceptGroupName: string
fa: boolean

Gets the value of the fa property. possible object is Boolean
rejectGroup: string
rejectGroupName: string
validate: boolean

Gets the value of the validate property. possible object is Boolean

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "description":"Gets the value of the validate property.\n \n     possible object is\n     Boolean"
        },
        "fa":{
            "type":"boolean",
            "description":"Gets the value of the fa property.\n \n     possible object is\n     Boolean"
        },
        "acceptGroup":{
            "type":"string"
        },
        "rejectGroup":{
            "type":"string"
        },
        "acceptGroupName":{
            "type":"string"
        },
        "rejectGroupName":{
            "type":"string"
        }
    }
}

Nested Schema : OutboundAgr.Schedule

Type: object

Show Source

endDate: string
frequency: object OutboundAgr.Schedule.Frequency
name: string
scheduleTZ: string
scheduleTZDisplayName: string
startDate: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        },
        "scheduleTZDisplayName":{
            "type":"string"
        },
        "scheduleTZ":{
            "type":"string"
        },
        "frequency":{
            "$ref":"#/components/schemas/OutboundAgr.Schedule.Frequency"
        }
    }
}

Nested Schema : tpIdentifiersRef

Type: array

Show Source

Array of: IdentifierRs

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

Nested Schema : HostIdentifierRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object HostIdentifierRs-allOf[2]

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

Nested Schema : HostIdentifierRs-allOf[2]

Type: object

Show Source

id: string
identifierType: string
identifierValue: string

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

Nested Schema : OutboundAgr.Schedule.Frequency

Type: object

Show Source

frequencyType: string
interval: string

{
    "type":"object",
    "properties":{
        "frequencyType":{
            "type":"string"
        },
        "interval":{
            "type":"string"
        }
    }
}

Nested Schema : IdentifierRs

Match All

Show Source

allOf IdRs
object GenericRestRs
object IdentifierRs-allOf[2]

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

Nested Schema : IdentifierRs-allOf[2]

Type: object

Show Source

id: string
identifierType: string
identifierValue: string

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

404 Response

Not found

412 Response

Pre-condition failure

500 Response

Server error