Skip to content

industrydata-sourcesystemdefinition-post.md

Latest commit

 

History

History
180 lines (141 loc) · 6.86 KB

industrydata-sourcesystemdefinition-post.md

File metadata and controls

180 lines (141 loc) · 6.86 KB
title Create sourceSystemDefinition
description Create a new sourceSystemDefinition object.
author mlafleur
ms.localizationpriority medium
ms.subservice industry-data-etl
doc_type apiPageType
ms.date 04/05/2024

Create sourceSystemDefinition

Namespace: microsoft.graph.industryData

[!INCLUDE beta-disclaimer]

Create a new sourceSystemDefinition object.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /external/industryData/sourceSystems

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the microsoft.graph.industryData.sourceSystemDefinition object.

You can specify the following properties when you create a sourceSystemDefinition.

Property Type Description
displayName String The name of the source system. Maximum supported length is 100 characters. Required.
userMatchingSettings microsoft.graph.industryData.userMatchingSetting collection A collection of user matching settings by roleGroup. Optional.
vendor String The name of the vendor who supplies the source system. Maximum supported length is 100 characters. Optional.

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.industryData.sourceSystemDefinition object in the response body.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/external/industryData/sourceSystems
Content-Type: application/json
Content-length: 250

{
  "displayName": "Rostering source",
  "userMatchingSettings": [
    {
      "matchTarget": {
        "code": "userPrincipalName"
      },
      "priorityOrder": 0,
      "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups/staff",
      "sourceIdentifier": {
        "code": "username"
      }
    },
    {
      "matchTarget": {
        "code": "userPrincipalName"
      },
      "priorityOrder": 1,
      "roleGroup@odata.bind": "https://graph.microsoft.com/beta/external/industryData/roleGroups('students')",
      "sourceIdentifier": {
        "code": "username"
      }
    }
  ]
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/sourceSystems/$entity",
    "id": "aa050107-5784-4a8e-1876-08daddab21bc",
    "displayName": "Rostering source",
    "vendor": null,
    "userMatchingSettings": [
        {
            "priorityOrder": 0,
            "sourceIdentifier": {
                "code": "username"
            },
            "matchTarget": {
                "code": "userPrincipalName"
            }
        },
        {
            "priorityOrder": 1,
            "sourceIdentifier": {
                "code": "username"
            },
            "matchTarget": {
                "code": "userPrincipalName"
            }
        }
    ]
}