MS Planner – Plans – Get Plan Detail From Detail Items

Estimated reading: 2 minutes

MS Planner – Plans – Get Plan Detail From Detail Items

Get Planner plan details from a collection of plan details by id.

Action details

PropertyValue
Action labelMS Planner – Plans – Get Plan Detail From Detail Items
CategoryCloudTools
Apex class and methodGetMSPlannerPlanDetailById.getPlanDetailById
Input typeGetMSPlannerPlanDetailById.GetMSPlannerPlanDetailByIdInput
Output typeList<MSPlannerPlanDetails>
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 detail id to find
ItemsitemsList<MSPlannerPlanDetails>YesPlan details 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 details identifier
Shared With JSONsharedWithJsonStringShared-with object serialized as JSON
Category Descriptions JSONcategoryDescriptionsJsonStringCategory descriptions object serialized as JSON
OData TypeodataTypeStringOData type
OData ETagodataEtagStringOData etag
Additional PropertiesadditionalPropertiesList<DynamicObject>Additional data returned by query

Behavior and limits

sharedWithJson and categoryDescriptionsJson are model fields. The model mappings explicitly rename only @odata.type and @odata.etag; do not assume raw Graph sharedWith/categoryDescriptions objects are serialized into these fields automatically.

Use in Flow

Add MS Planner – Plans – Get Plan Detail From Detail 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.GetMSPlannerPlanDetailById.GetMSPlannerPlanDetailByIdInput request =
    new Apptigent.GetMSPlannerPlanDetailById.GetMSPlannerPlanDetailByIdInput();
request.id = 'REPLACE_WITH_ID';
request.items = new List<Apptigent.MSPlannerPlanDetails>{ /* previously retrieved items */ };

List<Apptigent.MSPlannerPlanDetails> results =
    Apptigent.GetMSPlannerPlanDetailById.getPlanDetailById(
        new List<Apptigent.GetMSPlannerPlanDetailById.GetMSPlannerPlanDetailByIdInput>{ 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 Plan Detail From Detail 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