Jump to

• Request
• Response

Create a Protective Service

post

/invoices/{invoiceGid}/protectiveServices

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.protectiveServices"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• protSrvCode: string
  Protective service code.
• protSrvRuleCode: string
  Protective service rule code.
• protSrvSeqNo: number (int32)
  Protective service sequence number.
• protSrvTemp: protSrvTemp
  Temperature requirement.

{
    "properties":{
        "protSrvSeqNo":{
            "description":"Protective service sequence number.",
            "type":"number",
            "format":"int32"
        },
        "protSrvCode":{
            "description":"Protective service code.",
            "type":"string"
        },
        "protSrvRuleCode":{
            "description":"Protective service rule code.",
            "type":"string"
        },
        "protSrvTemp":{
            "description":"Temperature requirement.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "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 : protSrvTemp

Temperature requirement.

Match All

Temperature requirement.

Show Source

• object amountType

{
    "description":"Temperature requirement.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

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

Root Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• protSrvCode: string
  Protective service code.
• protSrvRuleCode: string
  Protective service rule code.
• protSrvSeqNo: number (int32)
  Protective service sequence number.
• protSrvTemp: protSrvTemp
  Temperature requirement.

{
    "properties":{
        "protSrvSeqNo":{
            "description":"Protective service sequence number.",
            "type":"number",
            "format":"int32"
        },
        "protSrvCode":{
            "description":"Protective service code.",
            "type":"string"
        },
        "protSrvRuleCode":{
            "description":"Protective service rule code.",
            "type":"string"
        },
        "protSrvTemp":{
            "description":"Temperature requirement.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "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 : protSrvTemp

Temperature requirement.

Match All

Temperature requirement.

Show Source

• object amountType

{
    "description":"Temperature requirement.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "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

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• protSrvCode: string
  Protective service code.
• protSrvRuleCode: string
  Protective service rule code.
• protSrvSeqNo: number (int32)
  Protective service sequence number.
• protSrvTemp: protSrvTemp
  Temperature requirement.

{
    "properties":{
        "protSrvSeqNo":{
            "description":"Protective service sequence number.",
            "type":"number",
            "format":"int32"
        },
        "protSrvCode":{
            "description":"Protective service code.",
            "type":"string"
        },
        "protSrvRuleCode":{
            "description":"Protective service rule code.",
            "type":"string"
        },
        "protSrvTemp":{
            "description":"Temperature requirement.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "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 : protSrvTemp

Temperature requirement.

Match All

Temperature requirement.

Show Source

• object amountType

{
    "description":"Temperature requirement.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Back to Top