Jump to

• Request
• Response

View all Programs by Portfolio Name

get

/api/restapi/program/portfolio/name/{portfolioName}

This endpoint returns programs that meet the following requirements:

• The object is associated with a portfolio with a name that matches the value of the {portfolioName} path parameter.

Request

Path Parameters

• portfolioName(required): string
  The user-specified unique identifier of a portfolio.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityProgram>

Type: array

Title: List<ApiEntityProgram>

Show Source

• Array of: object ApiEntityProgram
  Title: ApiEntityProgram

{
    "title":"List<ApiEntityProgram>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgram",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgram

Type: object

Title: ApiEntityProgram

Show Source

• actualFinish: string (date-time)
  The Actual Finish displays the date on which a program is considered complete.
  This value can be entered manually or can be imported.
• actualsLinkType: string
  Maximum Length: 255

  The field source for the actuals curve in cash flow.
• actualStart: string (date-time)
  The Actual Start indicates the date work on the program began.
  This value can be entered manually or can be imported.
• benefitsFinishDate: string (date-time)
  The date benefits on the program finished.
• benefitsLinkType: string
  Maximum Length: 255

  The field source for the benefit curve in cash flow.
• benefitsStartDate: string (date-time)
  The date benefits on the program began.
• businessImpact: string
  Maximum Length: 4000

  A detailed description of the business impact of the program.
• codeValues: array codeValues
  The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.
• configuredFields: array configuredFields
  The list of configured fields for a program.
• createDate: string (date-time)
  The date the program was added.
• createUser: string
  Maximum Length: 255

  The user who added the program.
• description: string
  Maximum Length: 4000

  The detailed summary for the program. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are especially useful in multi-user environments.
• evaluationMatrixId: integer (int64)
  The unique identifier for the program evaluation.
• evaluationScore: number (double)
  The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.
• forecastFinishDate: string (date-time)
  The planned finish date of a program's remaining Forecast cost.
• forecastLinkType: string
  Maximum Length: 255

  The field source for the forecast curve in cash flow.
• forecastStartDate: string (date-time)
  The planned start date of a program's remaining Forecast cost.
• lastProgramEvaluationDate: string (date-time)
  The most recent evaluation date for the program.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• linkedObjects: array linkedObjects
  The list of projects linked to the program.
• linkForecastToSpend: boolean
  Enables you to link program Forecast data to program Actuals data.
  When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.
• owner: string
  Maximum Length: 255

  The manager or person responsible for the program.
• plannedBudgetLinkType: string
  Maximum Length: 255

  The field source for the planned budget curve in cash flow.
• plannedFinish: string (date-time)
  The finish date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
• plannedStart: string (date-time)
  The start date for the time phased Planned Budget of the program.
  Planned Budget cost spread will adjust when this date is changed.
  The Program Planned Start also represents the earliest date that activities can occur within a program schedule.
• problemOrOpportunity: string
  Maximum Length: 4000

  A detailed description of the problem or opportunity the program addresses.
• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• programName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the program.
• riskMatrixId: integer (int64)
  The risk matrix assigned to the program for calculating program risk scores.
• spendEffectiveDate: string (date-time)
  The month in which an actuals value was last added to the program
• spendFinishDate: string (date-time)
  The finish date for the program actuals.
• spendStartDate: string (date-time)
  The start date for the program actuals.
• status: string
  Allowed Values: [ "PLANNED", "ACTIVE", "INACTIVE", "ON_HOLD", "COMPLETE" ]

  The current status of the program.
• statusDate: string (date-time)
  The date and time the program status was changed.
• strategicObjective: string
  Maximum Length: 4000

  A detailed description of the strategic object of the program.
• updateDate: string (date-time)
  Date when the record was last updated.
• updateUser: string
  Maximum Length: 255

  The user who last modified the program
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityProgram",
    "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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "owner":{
            "maxLength":"255",
            "type":"string",
            "description":"The manager or person responsible for the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"The current status of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PLANNED",
                "ACTIVE",
                "INACTIVE",
                "ON_HOLD",
                "COMPLETE"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary for the program. The description provides more information than short names or titles. It can give background information or establish a purpose for the item. These details help differentiate between items with similar names and are especially useful in multi-user environments.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendStartDate":{
            "type":"string",
            "description":"The start date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who last modified the program",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createDate":{
            "type":"string",
            "description":"The date the program was added.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "createUser":{
            "maxLength":"255",
            "type":"string",
            "description":"The user who added the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueProgram",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationMatrixId":{
            "type":"integer",
            "description":"The unique identifier for the program evaluation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "plannedStart":{
            "type":"string",
            "description":"The start date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed. <br />The Program Planned Start also represents the earliest date that activities can occur within a program schedule.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedFinish":{
            "type":"string",
            "description":"The finish date for the time phased Planned Budget of the program. <br />Planned Budget cost spread will adjust when this date is changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualStart":{
            "type":"string",
            "description":"The Actual Start indicates the date work on the program began. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualFinish":{
            "type":"string",
            "description":"The Actual Finish displays the date on which a program is considered complete. <br />This value can be entered manually or can be imported.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "problemOrOpportunity":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the problem or opportunity the program addresses.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "businessImpact":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the business impact of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategicObjective":{
            "maxLength":"4000",
            "type":"string",
            "description":"A detailed description of the strategic object of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastFinishDate":{
            "type":"string",
            "description":"The planned finish date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastStartDate":{
            "type":"string",
            "description":"The planned start date of a program's remaining Forecast cost.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "spendFinishDate":{
            "type":"string",
            "description":"The finish date for the program actuals.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsStartDate":{
            "type":"string",
            "description":"The date benefits on the program began.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsFinishDate":{
            "type":"string",
            "description":"The date benefits on the program finished.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "evaluationScore":{
            "type":"number",
            "description":"The quantitative score of a program based on the qualitative ranking of programs against different evaluation categories. This value is used by portfolio managers to prioritize programs.",
            "format":"double",
            "exampleSetFlag":false
        },
        "lastProgramEvaluationDate":{
            "type":"string",
            "description":"The most recent evaluation date for the program.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMatrixId":{
            "type":"integer",
            "description":"The risk matrix assigned to the program for calculating program risk scores.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "spendEffectiveDate":{
            "type":"string",
            "description":"The month in which an actuals value was last added to the program ",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "linkForecastToSpend":{
            "type":"boolean",
            "description":"Enables you to link program Forecast data to program Actuals data. <br />When linked, any updates to the program's Actuals values will automatically be applied to the program's Forecast values.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "linkedObjects":{
            "type":"array",
            "description":"The list of projects linked to the program.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProgramLinkedObject",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "actualsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the actuals curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "forecastLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the forecast curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedBudgetLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the planned budget curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "benefitsLinkType":{
            "maxLength":"255",
            "type":"string",
            "description":"The field source for the benefit curve in cash flow.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusDate":{
            "type":"string",
            "description":"The date and time the program status was changed.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : codeValues

Type: array

The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueProgram
  Title: ApiEntityCodeValueProgram

{
    "type":"array",
    "description":"The list of code values for a program. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueProgram",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a program.

Show Source

• Array of: object ApiEntityProgramConfiguredFieldValue
  Title: ApiEntityProgramConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : linkedObjects

Type: array

The list of projects linked to the program.

Show Source

• Array of: object ApiEntityProgramLinkedObject
  Title: ApiEntityProgramLinkedObject

{
    "type":"array",
    "description":"The list of projects linked to the program.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramLinkedObject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeValueProgram

Type: object

Title: ApiEntityCodeValueProgram

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId: integer (int64)
  The ID for the code type.
• codeValueCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueObjectId: integer (int64)
  The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• programId: integer (int64)
  The unique identifier for the program.
• sequenceNumber: integer (int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueProgram",
    "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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The ID for the code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueObjectId":{
            "type":"integer",
            "description":"The system-generated unique identifier for the code value assignment. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramConfiguredFieldValue

Type: object

Title: ApiEntityProgramConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• configuredFieldObjectId: integer (int64)
  The unique identifier for the Program Configured Field.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• programId: integer (int64)
  The system-generated identifier of a Program.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramConfiguredFieldValue",
    "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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated identifier of a Program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "configuredFieldObjectId":{
            "type":"integer",
            "description":"The unique identifier for the Program Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProgramLinkedObject

Type: object

Title: ApiEntityProgramLinkedObject

Show Source

• action: string
  Allowed Values: [ "DELETE" ]
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• objectId: integer (int64)
  The system-generated identifier of a program linked object.
• objectType: string
  Maximum Length: 255

  The type of linked object.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProgramLinkedObject",
    "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",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "objectType":{
            "maxLength":"255",
            "type":"string",
            "description":"The type of linked object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "action":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "objectId":{
            "type":"integer",
            "description":"The system-generated identifier of a program linked object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested program does not exist, or you do not have access to it.

Back to Top