Jump to

• Request
• Response

Create a campaign goal

post

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/goals

Request

Path Parameters

• CampaignId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CampaignId(required): integer (int64)
  Campaign identifier for the goals associated with the campaign.
• GoalId: integer (int64)
  Internal identifier for the goals.
• GoalName(required): string
  Title: Question

  Maximum Length: 240

  Name of the goals.
• GoalTypeCode(required): string
  Maximum Length: 30

  Types of the goals.
• ObjectVersionNumber: integer (int32)
  Version number associated with the goals that the user retrieved.
• PrimaryGoalFlag: boolean
  Maximum Length: 1

  Indicates whether the primary goal is enabled or not
• responseChoices: array Campaign Goal Response Choices
  Title: Campaign Goal Response Choices

  The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.
• responseMetrics: array Campaign Goal Response Metrics
  Title: Campaign Goal Response Metrics

  The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.
• SystemGoalFlag: boolean
  Maximum Length: 1

  Indicates whether the system goal is enabled or not

{
    "required":[
        "CampaignId",
        "GoalName",
        "GoalTypeCode"
    ],
    "type":"object",
    "properties":{
        "CampaignId":{
            "type":"integer",
            "description":"Campaign identifier for the goals associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the goals that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "GoalTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Types of the goals.",
            "nullable":false
        },
        "GoalName":{
            "title":"Question",
            "maxLength":240,
            "type":"string",
            "description":"Name of the goals.",
            "nullable":false
        },
        "PrimaryGoalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the primary goal is enabled or not",
            "nullable":true
        },
        "responseMetrics":{
            "title":"Campaign Goal Response Metrics",
            "type":"array",
            "description":"The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseMetrics-item-post-request"
            }
        },
        "SystemGoalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the system goal is enabled or not",
            "nullable":true
        },
        "responseChoices":{
            "title":"Campaign Goal Response Choices",
            "type":"array",
            "description":"The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseChoices-item-post-request"
            }
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Campaign Goal Response Choices

Type: array

Title: Campaign Goal Response Choices

The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.

Show Source

• Array of: object communicateUICampaignDetails-goals-responseChoices-item-post-request

{
    "title":"Campaign Goal Response Choices",
    "type":"array",
    "description":"The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseChoices-item-post-request"
    }
}

Nested Schema : Campaign Goal Response Metrics

Type: array

Title: Campaign Goal Response Metrics

The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.

Show Source

• Array of: object communicateUICampaignDetails-goals-responseMetrics-item-post-request

{
    "title":"Campaign Goal Response Metrics",
    "type":"array",
    "description":"The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseMetrics-item-post-request"
    }
}

Nested Schema : communicateUICampaignDetails-goals-responseChoices-item-post-request

Type: object

Show Source

• DestinationURL: string
  Title: Response Destination Page URL

  Maximum Length: 1000

  Response choices destination URL.
• GoalId: integer (int64)
  Internal identifier for the response choices associated with goals.
• GoalResponseId: integer (int64)
  Internal identifier for the response choices.
• IncludeInTargetFlag: boolean
  Title: Counts Toward Goal

  Maximum Length: 1

  Default Value: false

  Indicates whether the include in target is enabled or not.
• ObjectVersionNumber: integer (int32)
  Version number associated with the response choices that the user retrieved.
• ResponseLabel: string
  Title: Response

  Maximum Length: 240

  Response choices label.
• UseDefaultURLFlag: boolean
  Title: Response Destination Page

  Maximum Length: 1

  Default Value: false

  Default URL flag for response choices.

{
    "type":"object",
    "properties":{
        "DestinationURL":{
            "title":"Response Destination Page URL",
            "maxLength":1000,
            "type":"string",
            "description":"Response choices destination URL.",
            "nullable":true
        },
        "UseDefaultURLFlag":{
            "title":"Response Destination Page",
            "maxLength":1,
            "type":"boolean",
            "description":"Default URL flag for response choices.",
            "nullable":true,
            "default":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the response choices that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"Internal identifier for the response choices.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IncludeInTargetFlag":{
            "title":"Counts Toward Goal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the include in target is enabled or not.",
            "nullable":true,
            "default":false
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the response choices associated with goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseLabel":{
            "title":"Response",
            "maxLength":240,
            "type":"string",
            "description":"Response choices label.",
            "nullable":false
        }
    }
}

Nested Schema : communicateUICampaignDetails-goals-responseMetrics-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : communicateUICampaignDetails-goals-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Campaign identifier for the goals associated with the campaign.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who created the goals.
• CreationDate: string (date-time)
  Read Only: true

  Date when the goals were added to the campaign.
• GoalId: integer (int64)
  Internal identifier for the goals.
• GoalName: string
  Title: Question

  Maximum Length: 240

  Name of the goals.
• GoalTypeCode: string
  Maximum Length: 30

  Types of the goals.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the goals were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the goals.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the goals.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the goals that the user retrieved.
• PrimaryGoalFlag: boolean
  Maximum Length: 1

  Indicates whether the primary goal is enabled or not
• responseChoices: array Campaign Goal Response Choices
  Title: Campaign Goal Response Choices

  The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.
• responseMetrics: array Campaign Goal Response Metrics
  Title: Campaign Goal Response Metrics

  The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.
• SystemGoalFlag: boolean
  Maximum Length: 1

  Indicates whether the system goal is enabled or not

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the goals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the goals were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who created the goals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryGoalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the primary goal is enabled or not",
            "nullable":true,
            "x-queryable":true
        },
        "responseMetrics":{
            "title":"Campaign Goal Response Metrics",
            "type":"array",
            "description":"The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseMetrics-item-response"
            }
        },
        "SystemGoalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the system goal is enabled or not",
            "nullable":true,
            "x-queryable":true
        },
        "responseChoices":{
            "title":"Campaign Goal Response Choices",
            "type":"array",
            "description":"The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseChoices-item-response"
            }
        },
        "CampaignId":{
            "type":"integer",
            "description":"Campaign identifier for the goals associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the goals that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "GoalTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Types of the goals.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalName":{
            "title":"Question",
            "maxLength":240,
            "type":"string",
            "description":"Name of the goals.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the goals were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated to the user who last updated the goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Campaign Goal Response Choices

Type: array

Title: Campaign Goal Response Choices

The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.

Show Source

• Array of: object communicateUICampaignDetails-goals-responseChoices-item-response

{
    "title":"Campaign Goal Response Choices",
    "type":"array",
    "description":"The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseChoices-item-response"
    }
}

Nested Schema : Campaign Goal Response Metrics

Type: array

Title: Campaign Goal Response Metrics

The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.

Show Source

• Array of: object communicateUICampaignDetails-goals-responseMetrics-item-response

{
    "title":"Campaign Goal Response Metrics",
    "type":"array",
    "description":"The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-goals-responseMetrics-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : communicateUICampaignDetails-goals-responseChoices-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the response choices of the goals.
• CreationDate: string (date-time)
  Read Only: true

  Date when the response choices of the goals were added to the campaign.
• DestinationURL: string
  Title: Response Destination Page URL

  Maximum Length: 1000

  Response choices destination URL.
• GoalId: integer (int64)
  Internal identifier for the response choices associated with goals.
• GoalResponseId: integer (int64)
  Internal identifier for the response choices.
• IncludeInTargetFlag: boolean
  Title: Counts Toward Goal

  Maximum Length: 1

  Default Value: false

  Indicates whether the include in target is enabled or not.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the response choices were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the response choices.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the response choices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number associated with the response choices that the user retrieved.
• ResponseLabel: string
  Title: Response

  Maximum Length: 240

  Response choices label.
• UseDefaultURLFlag: boolean
  Title: Response Destination Page

  Maximum Length: 1

  Default Value: false

  Default URL flag for response choices.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the response choices.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the response choices of the goals were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the response choices of the goals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseLabel":{
            "title":"Response",
            "maxLength":240,
            "type":"string",
            "description":"Response choices label.",
            "nullable":false,
            "x-queryable":true
        },
        "DestinationURL":{
            "title":"Response Destination Page URL",
            "maxLength":1000,
            "type":"string",
            "description":"Response choices destination URL.",
            "nullable":true,
            "x-queryable":true
        },
        "UseDefaultURLFlag":{
            "title":"Response Destination Page",
            "maxLength":1,
            "type":"boolean",
            "description":"Default URL flag for response choices.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the response choices that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"Internal identifier for the response choices.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeInTargetFlag":{
            "title":"Counts Toward Goal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the include in target is enabled or not.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the response choices were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated to the user who last updated the response choices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the response choices associated with goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : communicateUICampaignDetails-goals-responseMetrics-item-response

Type: object

Show Source

• GoalId: integer
  Read Only: true

  Internal identifier for the response metrics associated with goals.
• GoalResponseId: integer (int64)
  Read Only: true

  Internal identifier for the response metrics associated with response choices.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseCount: number
  Read Only: true

  Response count for the response choices
• ResponseLabel: string
  Read Only: true

  Maximum Length: 240

  Label for the response choices.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalResponseId":{
            "type":"integer",
            "description":"Internal identifier for the response metrics associated with response choices.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseCount":{
            "type":"number",
            "description":"Response count for the response choices",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"Internal identifier for the response metrics associated with goals.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseLabel":{
            "maxLength":240,
            "type":"string",
            "description":"Label for the response choices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

responseChoices

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/goals/{GoalId}/child/responseChoices

Parameters:

• CampaignId: $request.path.CampaignId
• GoalId: $request.path.GoalId

The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.

responseMetrics

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/goals/{GoalId}/child/responseMetrics

Parameters:

• CampaignId: $request.path.CampaignId
• GoalId: $request.path.GoalId

The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.

Back to Top