Jump to

• Request
• Response

Create a Note

post

/campaigns/{gtmCampaignGid}/lines/{gtmCampaignLineGid}/notes

Request

Path Parameters

• gtmCampaignGid(required): string
  Resource ID
• gtmCampaignLineGid(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/campaigns.lines.notes"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/campaigns.lines.notes"
    }
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• gtmCaLineNoteSeqNo: number (int64)
  The sequence number for campaign line note.
• isSystemGenerated: string
  No description.
• links: array links
  Read Only: true
• note: string
  Holds details note of user or system comment.
• noteDate: noteDate
  This fields holds the date on which note was added on campaign line.
• noteEnteredBy: string
  User id of user who provides the comment.
• summary: string
  Summery of user or system comment.

{
    "properties":{
        "gtmCaLineNoteSeqNo":{
            "description":"The sequence number for campaign line note.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "summary":{
            "description":"Summery of user or system comment.",
            "type":"string"
        },
        "note":{
            "description":"Holds details note of user or system comment.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"No description.",
            "type":"string"
        },
        "noteEnteredBy":{
            "description":"User id of user who provides the comment.",
            "type":"string"
        },
        "noteDate":{
            "description":"This fields holds the date on which note was added on campaign line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "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 : noteDate

This fields holds the date on which note was added on campaign line.

Match All

This fields holds the date on which note was added on campaign line.

Show Source

• object dateType

{
    "description":"This fields holds the date on which note was added on campaign line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

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

Root Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• gtmCaLineNoteSeqNo: number (int64)
  The sequence number for campaign line note.
• isSystemGenerated: string
  No description.
• links: array links
  Read Only: true
• note: string
  Holds details note of user or system comment.
• noteDate: noteDate
  This fields holds the date on which note was added on campaign line.
• noteEnteredBy: string
  User id of user who provides the comment.
• summary: string
  Summery of user or system comment.

{
    "properties":{
        "gtmCaLineNoteSeqNo":{
            "description":"The sequence number for campaign line note.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "summary":{
            "description":"Summery of user or system comment.",
            "type":"string"
        },
        "note":{
            "description":"Holds details note of user or system comment.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"No description.",
            "type":"string"
        },
        "noteEnteredBy":{
            "description":"User id of user who provides the comment.",
            "type":"string"
        },
        "noteDate":{
            "description":"This fields holds the date on which note was added on campaign line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "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 : noteDate

This fields holds the date on which note was added on campaign line.

Match All

This fields holds the date on which note was added on campaign line.

Show Source

• object dateType

{
    "description":"This fields holds the date on which note was added on campaign line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

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
  No description.
• gtmCaLineNoteSeqNo: number (int64)
  The sequence number for campaign line note.
• isSystemGenerated: string
  No description.
• links: array links
  Read Only: true
• note: string
  Holds details note of user or system comment.
• noteDate: noteDate
  This fields holds the date on which note was added on campaign line.
• noteEnteredBy: string
  User id of user who provides the comment.
• summary: string
  Summery of user or system comment.

{
    "properties":{
        "gtmCaLineNoteSeqNo":{
            "description":"The sequence number for campaign line note.",
            "type":"number",
            "format":"int64"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "summary":{
            "description":"Summery of user or system comment.",
            "type":"string"
        },
        "note":{
            "description":"Holds details note of user or system comment.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"No description.",
            "type":"string"
        },
        "noteEnteredBy":{
            "description":"User id of user who provides the comment.",
            "type":"string"
        },
        "noteDate":{
            "description":"This fields holds the date on which note was added on campaign line.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "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 : noteDate

This fields holds the date on which note was added on campaign line.

Match All

This fields holds the date on which note was added on campaign line.

Show Source

• object dateType

{
    "description":"This fields holds the date on which note was added on campaign line.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Back to Top