Jump to

• Request
• Response

View all Strategy Projects by Strategy

get

/api/restapi/strategyProject/strategy/{strategyId}

This endpoint returns strategy projects that meet the following requirements:

• The object is associated with a strategy with an ID value that matches the value of the {strategyId} path parameter.

Request

Path Parameters

• strategyId(required): integer(int64)
  The system-generated identifier of a strategy.

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<ApiEntityStrategyProject>

Type: array

Title: List<ApiEntityStrategyProject>

Show Source

• Array of: object ApiEntityStrategyProject
  Title: ApiEntityStrategyProject

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

Nested Schema : ApiEntityStrategyProject

Type: object

Title: ApiEntityStrategyProject

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• percentAlignment: number (double)
  The degree of alignment the project has to the strategy node. A single project can be aligned to multiple strategy nodes.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The system-generated identifier of a project.
• projectName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the project.
• strategyId: integer (int64)
  The system-generated identifier of a strategy.
• strategyProjectId: integer (int64)
  The system-generated identifier of a project associated with a strategy.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityStrategyProject",
    "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"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The system-generated identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategyProjectId":{
            "type":"integer",
            "description":"The system-generated identifier of a project associated with a strategy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "strategyId":{
            "type":"integer",
            "description":"The system-generated identifier of a strategy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "percentAlignment":{
            "type":"number",
            "description":"The degree of alignment the project has to the strategy node. A single project can be aligned to multiple strategy nodes.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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 Strategy Project does not exist, or you do not have access to it.

Back to Top