SetStateRequest クラス

適用対象: CRM 2015 on-prem, CRM Online

Contains the data that’s needed to set the state of an entity record.

名前空間: Microsoft.Crm.Sdk.Messages
アセンブリ: Microsoft.Crm.Sdk.Proxy (Microsoft.Crm.Sdk.Proxy.dll に含まれる)

構文

'宣言
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class SetStateRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class SetStateRequest : OrganizationRequest

例

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

// Create the Request Object
SetStateRequest state = new SetStateRequest();

// Set the Request Object's Properties
state.State = new OptionSetValue((int)IncidentState.Active);
state.Status = 
    new OptionSetValue((int)incident_statuscode.WaitingforDetails);

// Point the Request to the case whose state is being changed
state.EntityMoniker = caseReference;

// Execute the Request
SetStateResponse stateSet = (SetStateResponse)_serviceProxy.Execute(state);

// Check if the state was successfully set
Incident incident = _serviceProxy.Retrieve(Incident.EntityLogicalName, 
    _caseIncidentId, new ColumnSet(allColumns: true)).ToEntity<Incident>();

if (incident.StatusCode.Value == (int)incident_statuscode.WaitingforDetails)
{
    Console.WriteLine("Record state set successfully.");
}
else
{
    Console.WriteLine("The request to set the record state failed.");
}

備考

Message Availability

このメッセージは、呼び出し元がサーバーに接続されているか、オフラインであるかに関係なく機能します。 Not all entity types support this message offline. See Supported Entities later in this topic.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the SetStateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the EntityMoniker property.

For a complete list of the required privileges, see SetState Privileges.

Valid State and Status value combinations

The valid combinations of state and status code values varies for many entities. For a list of default values for specific system entities, see Default status and status reason values.

For a list of the state and status values valid for custom entities in your organization, refer to the entity metadata.

組織のエンティティ メタデータを表示するには、メタデータ ブラウザー ソリューションをインストールしてください。メタデータ ブラウザー ソリューションについて詳しくは、「組織のメタデータの参照」をご覧ください。カスタマイズされていない組織のメタデータを、EntityMetadata.xlsx という名前の Excel ファイルで見ることもできます。このファイルは、ダウンロードした SDK の最上位のフォルダーに含まれています。

Supported Entities

次の表は、このメッセージをサポートする既定のエンティティを示しています。また、メッセージを使用できるのが、呼び出し元がサーバーに接続されているとき (サーバー)、サーバーから切断されているとき (オフライン)、またはその両方 (両方) のいずれであるかを示します。

Entity	Availability
Account	2 (Both)
Appointment	2 (Both)
BusinessUnit	2 (Both)
Campaign	2 (Both)
CampaignActivity	2 (Both)
CampaignResponse	2 (Both)
Connection	2 (Both)
ConnectionRole	2 (Both)
Contact	2 (Both)
Contract	2 (Both)
ContractDetail	2 (Both)
ConvertRule	2 (Both)
DiscountType	2 (Both)
DynamicProperty	2 (Both)
Email	2 (Both)
EmailServerProfile	2 (Both)
Entitlement	2 (Both)
Fax	2 (Both)
Goal	2 (Both)
GoalRollupQuery	2 (Both)
ImportMap	2 (Both)
Incident	2 (Both)
IncidentResolution	2 (Both)
Invoice	2 (Both)
KbArticle	2 (Both)
Lead	2 (Both)
Letter	2 (Both)
List	2 (Both)
Mailbox	2 (Both)
MailMergeTemplate	2 (Both)
Metric	2 (Both)
msdyn_PostAlbum	2 (Both)
msdyn_PostConfig	2 (Both)
msdyn_PostRuleConfig	2 (Both)
msdyn_wallsavedquery	2 (Both)
msdyn_wallsavedqueryusersettings	2 (Both)
Opportunity	2 (Both)
OpportunityClose	2 (Both)
OrderClose	2 (Both)
PhoneCall	2 (Both)
Position	2 (Both)
PriceLevel	2 (Both)
ProcessSession	2 (Both)
Product	2 (Both)
ProductAssociation	2 (Both)
Queue	2 (Both)
QueueItem	2 (Both)
Quote	2 (Both)
QuoteClose	2 (Both)
RecurringAppointmentMaster	2 (Both)
RelationshipRole	2 (Both)
RoutingRule	2 (Both)
SalesOrder	2 (Both)
SavedQuery	2 (Both)
SdkMessageProcessingStep	2 (Both)
ServiceAppointment	2 (Both)
SharePointDocumentLocation	2 (Both)
SharePointSite	2 (Both)
SLA	2 (Both)
SocialActivity	2 (Both)
SocialProfile	2 (Both)
SystemUser	2 (Both)
Task	2 (Both)
TransactionCurrency	2 (Both)
UoMSchedule	2 (Both)
UserQuery	2 (Both)
Workflow	2 (Both)

継承階層

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.SetStateRequest

スレッド セーフ

この種類のパブリックな静的 (Visual Basic では Shared) メンバーはスレッド セーフです。インスタンス メンバーがスレッド セーフであることは保証されません。

プラットフォーム

開発プラットフォーム

Windows Vista、Windows Server 2003、および

対象プラットフォーム

Windows Vista、Windows XP

Change History

関連項目

参照

SetStateRequest のメンバー
Microsoft.Crm.Sdk.Messages 名前空間
SetStateResponse

他のリソース

SetState Privileges
Sample: Validate Record State and Set State of the Record
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM

Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.