Jump to

• Request
• Response

Create a Port

post

/invoices/{invoiceGid}/ports

Request

Path Parameters

• invoiceGid(required): string
  Resource ID

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.ports"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.ports"
    }
}

Nested Schema : schema

Type: object

Show Source

• countryCode3Gid: string
  The country code GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationIdentifier: string
  The location identifier.
• locationIdentifierQualifier: string
  The qualifier associated with the location identifier.
• portFunctionCode: string
  The port function code.
• portName: string
  The name of the port on the invoice.
• portSeqNo: number (int32)
  The sequence number for the port on the invoice.
• provinceCode: string
  The province code on the invoice.

{
    "properties":{
        "portSeqNo":{
            "description":"The sequence number for the port on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "portFunctionCode":{
            "description":"The port function code.",
            "type":"string"
        },
        "locationIdentifier":{
            "description":"The location identifier.",
            "type":"string"
        },
        "locationIdentifierQualifier":{
            "description":"The qualifier associated with the location identifier.",
            "type":"string"
        },
        "portName":{
            "description":"The name of the port on the invoice.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code on the invoice.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• countryCode3Gid: string
  The country code GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationIdentifier: string
  The location identifier.
• locationIdentifierQualifier: string
  The qualifier associated with the location identifier.
• portFunctionCode: string
  The port function code.
• portName: string
  The name of the port on the invoice.
• portSeqNo: number (int32)
  The sequence number for the port on the invoice.
• provinceCode: string
  The province code on the invoice.

{
    "properties":{
        "portSeqNo":{
            "description":"The sequence number for the port on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "portFunctionCode":{
            "description":"The port function code.",
            "type":"string"
        },
        "locationIdentifier":{
            "description":"The location identifier.",
            "type":"string"
        },
        "locationIdentifierQualifier":{
            "description":"The qualifier associated with the location identifier.",
            "type":"string"
        },
        "portName":{
            "description":"The name of the port on the invoice.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code on the invoice.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• countryCode3Gid: string
  The country code GID.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• locationIdentifier: string
  The location identifier.
• locationIdentifierQualifier: string
  The qualifier associated with the location identifier.
• portFunctionCode: string
  The port function code.
• portName: string
  The name of the port on the invoice.
• portSeqNo: number (int32)
  The sequence number for the port on the invoice.
• provinceCode: string
  The province code on the invoice.

{
    "properties":{
        "portSeqNo":{
            "description":"The sequence number for the port on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "portFunctionCode":{
            "description":"The port function code.",
            "type":"string"
        },
        "locationIdentifier":{
            "description":"The location identifier.",
            "type":"string"
        },
        "locationIdentifierQualifier":{
            "description":"The qualifier associated with the location identifier.",
            "type":"string"
        },
        "portName":{
            "description":"The name of the port on the invoice.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code on the invoice.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top