MS Planner – Plans – Get A Plan From Plan Items

Estimated reading: 2 minutes

MS Planner – Plans – Get A Plan From Plan Items

Get a Planner plan from a collection of all plans by id.

Action details

PropertyValue
Action labelMS Planner – Plans – Get All Plan From Plan Items
CategoryCloudTools
Apex class and methodGetAllMSPlannerPlanById.getPlanById
Input typeGetAllMSPlannerPlanById.GetAllMSPlannerPlanByIdInput
Output typeList<MSPlannerPlan>
AuthorizationNo connection required; searches an existing collection.

Prerequisites and permissions

Retrieve the collection first and pass its matching model type. This action performs no callout and needs no connector or Microsoft permissions of its own.

Inputs

InputApex fieldTypeRequiredDescription
IdidStringYesPlan id to find
ItemsitemsList<MSPlannerPlan>YesPlans to search

Outputs

Returns one result for each request, preserving order. A missing match, blank ID, null collection, or null request yields null. A null or empty request list returns a single null element. The helper selects the first non-null item whose id matches.

OutputApex fieldTypeDescription
IdidStringPlanner plan identifier
TitletitleStringPlanner plan title
OwnerownerStringMicrosoft 365 group identifier that owns the plan
Created Date TimecreatedDateTimeStringCreated timestamp
OData TypeodataTypeStringOData type
OData ETagodataEtagStringOData etag
Additional PropertiesadditionalPropertiesList<DynamicObject>Additional data returned by query

Use in Flow

Add MS Planner – Plans – Get All Plan From Plan Items in Flow Builder. Pass a previously retrieved collection and the ID to find. Check the returned item for null before using it.

Use in custom Apex

This subscriber-org example uses the Apptigent namespace. Replace the placeholders and check empty or null results. No callout context is needed.

Apptigent.GetAllMSPlannerPlanById.GetAllMSPlannerPlanByIdInput request =
    new Apptigent.GetAllMSPlannerPlanById.GetAllMSPlannerPlanByIdInput();
request.id = 'REPLACE_WITH_ID';
request.items = new List<Apptigent.MSPlannerPlan>{ /* previously retrieved items */ };

List<Apptigent.MSPlannerPlan> results =
    Apptigent.GetAllMSPlannerPlanById.getPlanById(
        new List<Apptigent.GetAllMSPlannerPlanById.GetAllMSPlannerPlanByIdInput>{ request }
    );
System.debug(results);

Use in a Lightning Web Component

This collection helper is not exported by msPlannerConnectorLib. For an existing JavaScript collection, use items.find(item => item && item.id === id) || null. This does not call Microsoft Graph.

Error handling and troubleshooting

SymptomWhat to check
Missing matchCheck the ID and collection type; a null match is expected when no item exists.

See Planner connector introduction.

Share this Doc

MS Planner – Plans – Get A Plan From Plan Items

Or copy link

CONTENTS

Free eBook: The Ultimate Guide to Power Platform Custom Connectors

Antimanual

Ask our AI support assistant your questions about our platform, features, and services.

You are offline
Chatbot avatar
What can I help you with?

Subscribe

×
Cancel