Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to get the metadata of items from the selected SharePoint Online document library. It fetches the children of an item. It is possible to You can also specify the folder name with the property “source item relative path“. If the expand option is enabled and the select fields property is filled, then the specification of the select field will also apply to the children items.

Image Removed

Prerequisites

...

Source Item Relative Path“ property.

...

Snap Type

SharePoint Online - Item Children is a Read-type Snap that fetches the children of an item.

Prerequisites

  • Valid SharePoint Online tenant and associated site.

  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines

...

. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see refer to Snap Support for Ultra Pipelines.

Limitations and Known Issues

None. 

Snap

...

Views

View Type

View Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap
  • Copy Snap
    • CSV Parser

  • JSON Parser
  •  An input 
    • Azure SQL Execute

     An input document contains the metadata of the folder for which the children items need to be retrieved.


    Output

    Document

    • Min: 1

    • Max: 1

  • Mapper Snap
  • Copy Snap
  • CSV Parser
    • Pipeline Execute

    • JSON Parser

    An output document contains the metadata information of the children of the configured folder.

    Error

    Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

    • Stop Pipeline Execution: Stops the current Pipeline execution when the Snap encounters an error.

    • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

    • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

    Learn more about Error handling in Pipelines.

    Snap Settings

    ...

    Label

    ...

    String

    ...

    Info
    • Asterisk (*): Indicates a mandatory field.

    • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

    • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

    • Add icon ((blue star)): Indicates that you can add fields in the field set.

    • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

    Field Name

    Field Type

    Description

    Label*

    Default ValueSharePoint Online - Item Children
    ExampleSharePoint Online - Item Children

    String

    Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

    NSite

    Site*

    Default Value: N/A

    SharePoint Online - Item Children

    ExampleMySite

    String

    Required. The

    /Expression

    Specify the name of a site

    that

    which contains the list of document library to be used in the subsequent Snap settings.

    N/A

    MySite

    Custom Site Path

    Check-box
    Multiexcerpt include macro
    nameME_Custom Site Path
    pageSharePoint unsafe-Online - Get Item
    Not SelectedSelected

    Document Library

    String

    Required. This property enables you to select 

    Default ValueDeselected

    Checkbox

    Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has a prefix ‘sites/’ before the sitename, a custom site can contain the prefix ‘teams/’ or it can have no prefiix.

    Document Library*

    Default Value: N/A
    ExampleShared Documents

    String/Expression

    Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This

    field  populates

    field will be populated dynamically from different sites

    via

    from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list or enter the entity name manually.

    Warning

    If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.

    N

    Source Item Relative Path*

    Default Value: N/A

    Shared Documents

    Source item relative path

    String

    Optional. The item resource

    ExampletestFile.pdf

    String/Expression

    Specify the item resource path that represents a file, folder, or other item stored in a document library

    to list the children. If this property is left empty, then the items of the document library will be retrieved.

    N/A

    testFile.pdf

    Select fields

    StringOptional. Enter the field names of the metadata that should be returned Orderby properties

    Optional. Enter these properties to perform the order of the result set. This fieldset comprises the following fields:

    • Property name
    • Order type

    Property name

    StringEnter

    .

    Select fields

    Default Value: N/A
    Exampleid, email, roles

    String/Expression

    Enter the comma-separated properties to be written to the output view.

    N/Aname, idString

    Order by Properties

    Use this fieldset to Enter the properties and order they want to be displayed when found more one item with one or more similar properties. 

    Property name

    Default Value: N/A
    Examplename

    String

    Specify the name of the property to be sorting order.

    N/AnameOrder type

    Order type

    Default Valueasc
    Exampledesc

    Dropdown list/Expression

    Select the appropriate sort order to be performed upon the selected items. Avaialble options are:

    • asc

    N/A
    • desc

    Top

    Default Value: 200
    Example500

    Integer

    Optional. Use this property to set

    /Expression

    Specify the page size of results.

    200500

    Top

    Auto pagination

    Check boxOptional. To

    Default Value: Deselected

    Checkbox

    Select to get all items within a single folder item/document directory. If this field is not checked, SharePoint Online will return a maximum of 200 records per page by default. If this field is selected, all matching records will be automatically returned.

    Not selectedN/A

    Connection details

    You can use this fieldset to influence

    Use this field set to specify connection properties to the SharePoint Online APIs.

    This fieldset comprises the following fields:Required. Enables you to set

     

    Connection timeout*

  • Number of retries
  • Retry interval (seconds)
  • Connection timeout

    Integer

    Default Value30
    Example40

    Integer

    Specify the connection timeout duration in seconds.

    3030. Enables you to set

    Number of retries*

    Default Value3
    Example5

    Integer

    Required

    Specify the maximum number of reconnections in case of a connection failure or timeout.

    351

    Retry interval (seconds)*

    Default Value10
    Example11

    Integer

    Required. Enables you to set

    Snap Execution

    String

    Specify the 

    Specify the time interval in seconds between connection attempts.

    1020

    Snap Execution

    Default ValueValidate & Execute
    ExampleExecute only

    Dropdown list

    Specify the required Pipeline execution type:

    • Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

    • Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

    • Disabled. Disables the Snap and, by extension, its downstream Snaps.

    Execute only

    Validate & Execute
    Info

    For more information on how to list the children of a folder and document library in the SharePoint Online, refer to the graph API in drive-list-children.

    Troubleshooting

    Error

    Reason

    Resolution

    HTTP Response Code:404

    Entered item not found in the document library.

    Ensure to provide the valid item path to get the metadata.

    Forbidden exception:403

    Either user or app doesn't have sufficient permissions to read the metadata for the document library.

    Ensure to provide the desired permissions both at the user and application level.

    Internal Server Error: 501

    Value for the Property name might have missed.

    Ensure to provide the value for the property name in the order by property.

    Examples

    Retrieving Item Children Files in the Source Folder

    This example demonstrates how to how to get item children files in the source folder. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).Image Removed

    ...

    The following screenshot displays the settings of the SharePoint SharePoint Online - Item Children Snap. The Snap specifies on how to get the children of a provided folder and sort them based on their names.Image Removed

    ...

    After successfully validating/executing the above Snap, the results display in the following output preview.Image Removed

    ...

    Download this Pipeline.

    Downloads

    Noteinfo
    title

    Important Steps to Successfully Reuse Pipelines

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Furnish Pipeline parameters as applicable.

    Attachments
    patterns*.slp

    Snap Pack History

    Expand

    Insert excerpt
    SharePoint Online Snap Pack
    SharePoint Online Snap Pack
    nameSharePoint Online SPH
    nopaneltrue

    See Also

    ...

    Related Content

    ...