Jump to

• Request
• Response

Apply Activity Uncertainty

post

/api/restapi/action/applyActivityUncertainity/run

Send a request to this endpoint to apply activity uncertainty for a project. This endpoint returns a job ID. Send a request to the View Job Status endpoint to view the status of the activity uncertainty job.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityApplyActivityUncertainity

Type: object

Title: ApiEntityApplyActivityUncertainity

Show Source

• distributionShape(required): string
  Allowed Values: [ "NONE", "TRIANGLE", "UNIFORM", "BETAPERT" ]

  The probability distribution that best models the three-point estimate durations.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• maxDuration: number (double)
  The estimated maximum amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.
• minDuration: number (double)
  The estimated least amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.
• mostLikelyDuration: number (double)
  The estimated most likely amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.
• overwriteExisting: boolean
  If true, activity uncertainty fields will be overwritten.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  Read Only: true

  The ID of the project that the activity is in.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityApplyActivityUncertainity",
    "required":[
        "distributionShape",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "distributionShape":{
            "type":"string",
            "description":"The probability distribution that best models the three-point estimate durations.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NONE",
                "TRIANGLE",
                "UNIFORM",
                "BETAPERT"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The ID of the project that the activity is in.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "minDuration":{
            "type":"number",
            "description":"The estimated least amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.",
            "format":"double",
            "exampleSetFlag":false
        },
        "maxDuration":{
            "type":"number",
            "description":"The estimated maximum amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.",
            "format":"double",
            "exampleSetFlag":false
        },
        "overwriteExisting":{
            "type":"boolean",
            "description":"If true, activity uncertainty fields will be overwritten.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "mostLikelyDuration":{
            "type":"number",
            "description":"The estimated most likely amount of time required to complete the activity. This field is used for three-point estimation to indicate activity uncertainty.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Apply Activity Uncertainity

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityScheduleJob

Type: object

Title: ApiEntityScheduleJob

Show Source

• jobId: integer (int64)
  The unique identifier for the background service.
• jobKey: integer (int64)
  The unique identifier for a job.
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the background service.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScheduleJob",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobKey":{
            "type":"integer",
            "description":"The unique identifier for a job.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top