Jump to

• Request
• Response

Create a milestone

post

/crmRestApi/resources/11.13.18.05/milestones

Request

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

• AllowAgentCompletionFlag: boolean
  Title: Allow Agent Completion

  Maximum Length: 1

  Default Value: false

  Allow Agent to mark milestone as complete
• AllowDueDateOverrideFlag: boolean
  Title: Allow Due Date Override

  Maximum Length: 1

  Default Value: false

  Allow Agent to override milestone due date
• BUOrgId: integer (int64)
  The unique ID of the business unit name associated to the Milestone Config.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Deleted Flag
• DisabledFlag: boolean
  Title: Disabled

  Maximum Length: 1

  Default Value: false

  Disabled Flag
• MilestoneCode: string
  Title: Milestone Code

  Maximum Length: 255

  The unique code associated with the milestone.
• MilestoneLabel: string
  Title: Milestone Label

  Maximum Length: 255

  The user-friendly label of the milestone.
• MilestoneType: string
  Title: Milestone Type

  Maximum Length: 255

  Default Value: ORA_SVC_NO_REPEAT

  The type of the milestone.
• ObjectName: string
  Maximum Length: 255

  The name of the object associated to the Milestone Configuration
• PauseCondition: string
  Title: Pauses When

  Maximum Length: 1000

  Pause Condition
• PauseConditionLabel: string
  Title: Pauses When

  Maximum Length: 1000

  The user-friendly label of the milestone's pause condition.
• StartCondition: string
  Title: Starts When

  Maximum Length: 1000

  Start Condition
• StartConditionLabel: string
  Title: Starts When

  Maximum Length: 1000

  The user-friendly label of the milestone's start condition.
• StopCondition: string
  Title: Complete When

  Maximum Length: 1000

  Stop Condition
• StopConditionLabel: string
  Title: Completes When

  Maximum Length: 1000

  The user-friendly label of the milestone's stop condition.
• ThresholdCode: string
  Title: Threshold Code

  Maximum Length: 255

  The unique code associated with the threshold.
• TzPreferenceCd: string
  Title: Time Zone Override Source

  Maximum Length: 30

  Indicates the object that will be used to override the time zone from the coverage.

{
    "type":"object",
    "properties":{
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to mark milestone as complete",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to override milestone due date",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "BUOrgId":{
            "type":"integer",
            "description":"The unique ID of the business unit name associated to the Milestone Config.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Deleted Flag",
            "nullable":false,
            "default":false
        },
        "DisabledFlag":{
            "title":"Disabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Disabled Flag",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "MilestoneCode":{
            "title":"Milestone Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the milestone.",
            "nullable":false
        },
        "MilestoneLabel":{
            "title":"Milestone Label",
            "maxLength":255,
            "type":"string",
            "description":"The user-friendly label of the milestone.",
            "nullable":true
        },
        "MilestoneType":{
            "title":"Milestone Type",
            "maxLength":255,
            "type":"string",
            "description":"The type of the milestone.",
            "nullable":false,
            "default":"ORA_SVC_NO_REPEAT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the object associated to the Milestone Configuration",
            "nullable":false
        },
        "PauseCondition":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"Pause Condition",
            "nullable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's pause condition.",
            "nullable":true
        },
        "StartCondition":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"Start Condition",
            "nullable":true
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's start condition.",
            "nullable":true
        },
        "StopCondition":{
            "title":"Complete When",
            "maxLength":1000,
            "type":"string",
            "description":"Stop Condition",
            "nullable":true
        },
        "StopConditionLabel":{
            "title":"Completes When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's stop condition.",
            "nullable":true
        },
        "ThresholdCode":{
            "title":"Threshold Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the threshold.",
            "nullable":true
        },
        "TzPreferenceCd":{
            "title":"Time Zone Override Source",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the object that will be used to override the time zone from the coverage.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : milestones-item-response

Type: object

Show Source

• AllowAgentCompletionFlag: boolean
  Title: Allow Agent Completion

  Maximum Length: 1

  Default Value: false

  Allow Agent to mark milestone as complete
• AllowDueDateOverrideFlag: boolean
  Title: Allow Due Date Override

  Maximum Length: 1

  Default Value: false

  Allow Agent to override milestone due date
• BUOrgId: integer (int64)
  The unique ID of the business unit name associated to the Milestone Config.
• BusinessUnitName: string
  Title: Business Unit Name

  Read Only: true

  Maximum Length: 240

  The name of the business unit associated to the Milestone Configuration
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Creation Date
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Deleted Flag
• DisabledFlag: boolean
  Title: Disabled

  Maximum Length: 1

  Default Value: false

  Disabled Flag
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Last Update Date
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Last Updated By
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Last Update Login
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MilestoneCode: string
  Title: Milestone Code

  Maximum Length: 255

  The unique code associated with the milestone.
• MilestoneConfigId: integer (int64)
  Title: Milestone Configuration ID

  Read Only: true

  The unique identifier of the milestone configuration.
• MilestoneLabel: string
  Title: Milestone Label

  Maximum Length: 255

  The user-friendly label of the milestone.
• MilestoneType: string
  Title: Milestone Type

  Maximum Length: 255

  Default Value: ORA_SVC_NO_REPEAT

  The type of the milestone.
• MilestoneTypeMeaning: string
  Read Only: true

  Indicates the display value corresponding to the milestone type lookup code.
• ObjectName: string
  Maximum Length: 255

  The name of the object associated to the Milestone Configuration
• ObjectNameMeaning: string
  Read Only: true

  Indicates the display value corresponding to the object name lookup code.
• PauseCondition: string
  Title: Pauses When

  Maximum Length: 1000

  Pause Condition
• PauseConditionLabel: string
  Title: Pauses When

  Maximum Length: 1000

  The user-friendly label of the milestone's pause condition.
• StartCondition: string
  Title: Starts When

  Maximum Length: 1000

  Start Condition
• StartConditionLabel: string
  Title: Starts When

  Maximum Length: 1000

  The user-friendly label of the milestone's start condition.
• StopCondition: string
  Title: Complete When

  Maximum Length: 1000

  Stop Condition
• StopConditionLabel: string
  Title: Completes When

  Maximum Length: 1000

  The user-friendly label of the milestone's stop condition.
• ThresholdCode: string
  Title: Threshold Code

  Maximum Length: 255

  The unique code associated with the threshold.
• TzPreferenceCd: string
  Title: Time Zone Override Source

  Maximum Length: 30

  Indicates the object that will be used to override the time zone from the coverage.
• TzPreferenceMeaning: string
  Read Only: true

  Maximum Length: 255

  Indicates the display value corresponding to the time zone object lookup code.

{
    "type":"object",
    "properties":{
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to mark milestone as complete",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to override milestone due date",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "type":"integer",
            "description":"The unique ID of the business unit name associated to the Milestone Config.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit associated to the Milestone Configuration",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Deleted Flag",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Disabled Flag",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last Update Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneCode":{
            "title":"Milestone Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the milestone.",
            "nullable":false,
            "x-queryable":true
        },
        "MilestoneConfigId":{
            "title":"Milestone Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Milestone Label",
            "maxLength":255,
            "type":"string",
            "description":"The user-friendly label of the milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneType":{
            "title":"Milestone Type",
            "maxLength":255,
            "type":"string",
            "description":"The type of the milestone.",
            "nullable":false,
            "default":"ORA_SVC_NO_REPEAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MilestoneTypeMeaning":{
            "type":"string",
            "description":"Indicates the display value corresponding to the milestone type lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MilestoneType"
                ]
            },
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the object associated to the Milestone Configuration",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectNameMeaning":{
            "type":"string",
            "description":"Indicates the display value corresponding to the object name lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PauseCondition":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"Pause Condition",
            "nullable":true,
            "x-queryable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's pause condition.",
            "nullable":true,
            "x-queryable":true
        },
        "StartCondition":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"Start Condition",
            "nullable":true,
            "x-queryable":true
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's start condition.",
            "nullable":true,
            "x-queryable":true
        },
        "StopCondition":{
            "title":"Complete When",
            "maxLength":1000,
            "type":"string",
            "description":"Stop Condition",
            "nullable":true,
            "x-queryable":true
        },
        "StopConditionLabel":{
            "title":"Completes When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's stop condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ThresholdCode":{
            "title":"Threshold Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the threshold.",
            "nullable":true,
            "x-queryable":true
        },
        "TzPreferenceCd":{
            "title":"Time Zone Override Source",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the object that will be used to override the time zone from the coverage.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TzPreferenceMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the display value corresponding to the time zone object lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Links

YesNoLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: AllowAgentCompletionFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top