REST API for Oracle Primavera Gateway

Returns Load Objects by app instance id and flow id

post

/gatewayapi/restapi/v1/externalStep/loadObjects

Request

Supported Media Types

multipart/mixed

Root Schema : MultiPart

Type: object

Show Source

bodyParts: array bodyParts
contentDisposition: object ContentDisposition
entity: object entity
headers: object headers

Additional Properties Allowed: additionalProperties
mediaType: object MediaType
messageBodyWorkers: object MessageBodyWorkers
parameterizedHeaders: object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent: object MultiPart
providers: object Providers

{
    "type":"object",
    "properties":{
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "messageBodyWorkers":{
            "$ref":"#/definitions/MessageBodyWorkers"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : bodyParts

Type: array

Show Source

[0]: object BodyPart

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BodyPart"
    }
}

Nested Schema : ContentDisposition

Type: object

Show Source

creationDate: string(date-time)
fileName: string
modificationDate: string(date-time)
parameters: object parameters

Additional Properties Allowed: additionalProperties
readDate: string(date-time)
size: integer(int64)
type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : MediaType

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
subtype: string
type: string
wildcardSubtype: boolean

Default Value: false
wildcardType: boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean",
            "default":false
        },
        "wildcardSubtype":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : MessageBodyWorkers

Type: object

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : Providers

Type: object

Nested Schema : BodyPart

Type: object

Show Source

contentDisposition: object ContentDisposition
entity: object entity
headers: object headers

Additional Properties Allowed: additionalProperties
mediaType: object MediaType
messageBodyWorkers: object MessageBodyWorkers
parameterizedHeaders: object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent: object MultiPart
providers: object Providers

{
    "type":"object",
    "properties":{
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "messageBodyWorkers":{
            "$ref":"#/definitions/MessageBodyWorkers"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

[0]: string

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

Nested Schema : additionalProperties

Type: array

Show Source

[0]: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Nested Schema : ParameterizedHeader

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

[0]: string

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

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

[0]: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Response

Supported Media Types

multipart/form-data

200 Response

successful operation

Root Schema : MultiPart

Type: object

Show Source

bodyParts: array bodyParts
contentDisposition: object ContentDisposition
entity: object entity
headers: object headers

Additional Properties Allowed: additionalProperties
mediaType: object MediaType
messageBodyWorkers: object MessageBodyWorkers
parameterizedHeaders: object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent: object MultiPart
providers: object Providers

{
    "type":"object",
    "properties":{
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "messageBodyWorkers":{
            "$ref":"#/definitions/MessageBodyWorkers"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : bodyParts

Type: array

Show Source

[0]: object BodyPart

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BodyPart"
    }
}

Nested Schema : ContentDisposition

Type: object

Show Source

creationDate: string(date-time)
fileName: string
modificationDate: string(date-time)
parameters: object parameters

Additional Properties Allowed: additionalProperties
readDate: string(date-time)
size: integer(int64)
type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : MediaType

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
subtype: string
type: string
wildcardSubtype: boolean

Default Value: false
wildcardType: boolean

Default Value: false

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean",
            "default":false
        },
        "wildcardSubtype":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : MessageBodyWorkers

Type: object

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : Providers

Type: object

Nested Schema : BodyPart

Type: object

Show Source

contentDisposition: object ContentDisposition
entity: object entity
headers: object headers

Additional Properties Allowed: additionalProperties
mediaType: object MediaType
messageBodyWorkers: object MessageBodyWorkers
parameterizedHeaders: object parameterizedHeaders

Additional Properties Allowed: additionalProperties
parent: object MultiPart
providers: object Providers

{
    "type":"object",
    "properties":{
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "messageBodyWorkers":{
            "$ref":"#/definitions/MessageBodyWorkers"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

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

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

[0]: string

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

Nested Schema : additionalProperties

Type: array

Show Source

[0]: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Nested Schema : ParameterizedHeader

Type: object

Show Source

parameters: object parameters

Additional Properties Allowed: additionalProperties
value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

[0]: string

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

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

[0]: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

404 Response

The Load Objects do not exist or you do not have access to it.