afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/DevopsRequestInfo.json

83 lines
9.9 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"usage",
"associated_objects",
"wsdl_segment"
],
"title": "DevopsRequestInfo - Data API",
"description": "Represents a specific request for a DevOps Center operation, such as a commit, deploy, promotion, rebase, or back sync, and tracks its overall status and outcome. This object is available in API version 66.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"refers_to"
],
"fields": {
"ErrorDetails": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "Provides detailed information if the requested operation encounters an error."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record."
},
"LastViewedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate is not null, the user accessed this record or list view indirectly."
},
"Message": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A status message or summary description regarding the current state of the request."
},
"Name": {
"type": "string",
"properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
"description": "The unique identifier for the request info record."
},
"OperationType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
"description": "Indicates the specific type of DevOps Center action performed. Possible values are: BACK_SYNC COMMIT DEPLOY INSPECT MIGRATE PROMOTE REBASE REBASE_AND_COMBINE SWAP TEST_ONLY TEST_RESUME The default value is PROMOTE."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID of the owner of this record. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"refers_to": "Group, User"
},
"ParentRequestInfoId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of a parent request info record, used for tracking related or suboperations. This field is a relationship field.",
"relationship_name": "ParentRequestInfo",
"refers_to": "DevopsRequestInfo"
},
"RequestCompletionDate": {
"type": "dateTime",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The date and time when the requested operation was completed."
},
"RequestToken": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "A unique token used to correlate the request with external source control systems or event processing."
},
"Status": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update",
"description": "The current state of the DevOps request. Possible values are: CANCELLED ERROR FINALIZING INTERRUPTED IN_PROGRESS NEW SUCCESS The default value is NEW."
}
},
"usage": "Use this object to monitor the lifecycle of asynchronous DevOps Center operations. For example, when you promote a work item or run a back sync, DevOps Center creates a DevopsRequestInfo record to manage that specific operation. It acts as a central point for tracking whether an operation is still in progress, has succeeded, or requires troubleshooting due to an error. If a promotion or commit appears stalled, you can query this object to find the associated result and determine if the external services completed the task successfully.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **DevopsRequestInfoChangeEvent**: Change events are available for the object.\n- **DevopsRequestInfoFeed**: Feed tracking is available for the object.\n- **DevopsRequestInfoHistory**: History is available for tracked fields of the object.\n- **DevopsRequestInfoOwnerSharingRule**: Sharing rules are available for the object.\n- **DevopsRequestInfoShare**: Sharing is available for the object.",
"wsdl_segment": "```xml\n<complexType name=\"DevopsRequestInfo\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ActivityHistories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalSubmissions\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ApprovalWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"AttachedContentDocuments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Attachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ChildDevopsRequestInfos\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"DevopsRequestInfos\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Emails\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ErrorDetails\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Events\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FeedSubscriptionsForEntity\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Feeds\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"FlowOrchestrationWorkItems\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Histories\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastReferencedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LastViewedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"LookedUpFromActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"Message\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Notes\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"NotesAndAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OpenActivities\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"OperationType\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Owner\" nillable=\"true\" minOccurs=\"0\" type=\"ens:sObject\"/>\n <element name=\"OwnerId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ParentRequestInfo\" nillable=\"true\" minOccurs=\"0\" type=\"ens:DevopsRequestInfo\"/>\n <element name=\"ParentRequestInfoId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n <element name=\"RequestCompletionDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <
}