POST v1/DomainAssignments

Submits many domain assignments for processing. At most 100 assignments can be submitted at a time. If assignments with the same object id/domain id already exist, they will be updated. When a user logs in and there are multiple relevant assignments (for example, multiple groups), the one with the most powerful role wins. This endpoint requires bearer authentication with an Azure Active Directory token.

Request Information

URI Parameters

None.

Body Parameters

DomainAssignmentsModel

Name	Description	Type	Additional information
DomainAssignments	The domain assignments to create or update.	Collection of DomainAssignmentModel	None.

Request Formats

application/json, text/json

Sample:

{
    "DomainAssignments": [
        {
            "ObjectId": "5b33ecf3-9e72-4333-88b5-017898ad2948",
            "ObjectType": 3,

            "DomainName": "Fieldwork France",
            "Role": "RegularUser"
        },
        {
            "ObjectId": "c7f38965-78eb-4e70-80c2-9a074185de5d",
            "ObjectType": 3,

            "DomainName": "Fieldwork France",
            "Role": "DomainAdministrator"
        },
        {
            "ObjectId": "c7f38965-78eb-4e70-80c2-9a074185de5d",
            "ObjectType": 3,

            "DomainName": "Fieldwork Germany",
            "Role": "RegularUser"
        },
    ]
}

application/xml, text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

DomainAssignments=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The activity ID can be used with the BackgroundActivities endpoint to request the status and other information.

Response Message

BackgroundActivityStatus

Name	Description	Type	Additional information
ActivityId	The id of the started activity	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ActivityId": "sample string 1"
}

application/xml, text/xml

Sample:

<BackgroundActivityStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <ActivityId>sample string 1</ActivityId>
</BackgroundActivityStatus>