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

{
  "sections": [
    "title",
    "description",
    "fields",
    "usage",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "ContractLineOutcome - Data API",
  "description": "Represents information on a contract line outcome’s captured data and other related parameters that are used when capturing data. This object is available in API version 58.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "relationship_type",
    "refers_to"
  ],
  "fields": {
    "CalculationMethod": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The method used for calculating the contract line outcome’s captured data to determine the outcome value. Select Average or As Captured to calculate the contract line outcome. Average calculates the outcome value based on the average of all data captured to date. As Captured calculates the outcome value based on the asset’s current data at the time of the compliance check. Possible values are: AsCaptured Average"
    },
    "CaptureFrequency": {
      "type": "picklist",
      "properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
      "description": "The frequency at which data capturing and contract compliance check for the contract line outcome occurs. Possible values are: Daily Monthly Weekly"
    },
    "ComplianceStatus": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort",
      "description": "Indicates if the criteria were met. Compliant–The outcome is compliant with the contract. Not Compliant–The outcome isn’t compliant with the contract. Not Available–The outcome’s compliance information isn’t available yet. Invalid–The outcome isn’t valid because the option selected for the Criteria Field of the recordset filter criteria was deleted. To restart the calculation, create a new contract line outcome. Possible values are: Compliant Invalid NotAvailable NotCompliant The default value is NotAvailable."
    },
    "ContractLineItemId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Sort, Update",
      "description": "The contract line item associated with the contract line outcome. This field is a relationship field.",
      "relationship_name": "ContractLineItem",
      "relationship_type": "Lookup",
      "refers_to": "ContractLineItem"
    },
    "Description": {
      "type": "textarea",
      "properties": "Create, Nillable, Update",
      "description": "A description of the contract line outcome."
    },
    "EndDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Sort, Update",
      "description": "The contract line outcome's data capture end date."
    },
    "LastReferencedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time when the contract line outcome was last modified. Its UI label is Last Modified Date."
    },
    "LastViewedDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date and time when the contract line outcome was last viewed."
    },
    "Name": {
      "type": "string",
      "properties": "Create, Filter, Group, idLookup, Sort, Update",
      "description": "The name of the contract line outcome."
    },
    "NextDataCaptureDate": {
      "type": "dateTime",
      "properties": "Filter, Nillable, Sort",
      "description": "The date of the next data capture and compliance check based on the capture frequency. The date is auto-populated and updated after each capture"
    },
    "OwnerId": {
      "type": "reference",
      "properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
      "description": "The contract line outcome’s owner. By default, the owner is the user who created the contract line outcome record. Its UI label is Contract Line Outcome Owner. This field is a polymorphic relationship field.",
      "relationship_name": "Owner",
      "relationship_type": "Lookup",
      "refers_to": "Group, User"
    },
    "RecordsetFilterCriteriaId": {
      "type": "reference",
      "properties": "Create, Filter, Group, Nillable, Sort, Update",
      "description": "The ID of the recordset filter criteria in which the contract line outcome’s conditions are defined. This field is a relationship field.",
      "relationship_name": "RecordsetFilterCriteria",
      "relationship_type": "Lookup",
      "refers_to": "RecordsetFilterCriteria"
    },
    "ServiceContractId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The service contract associated with the contract line item and the contract line outcome. This field is a relationship field.",
      "relationship_name": "ServiceContract",
      "relationship_type": "Lookup",
      "refers_to": "ServiceContract"
    },
    "StartDate": {
      "type": "dateTime",
      "properties": "Create, Filter, Sort, Update",
      "description": "The contract line outcome's data capture start date."
    }
  },
  "usage": "Use this object to define the data capture frequency and other related parameters that are used when capturing data in order to evaluate a service contract’s compliance.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **ContractLineOutcomeChangeEvent**: Change events are available for the object.\n- **ContractLineOutcomeFeed**: Feed tracking is available for the object.\n- **ContractLineOutcomeHistory**: History is available for tracked fields of the object.\n- **ContractLineOutcomeOwnerSharingRule**: Sharing rules are available for the object.\n- **ContractLineOutcomeShare**: Sharing is available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"ContractLineOutcome\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\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=\"CalculationMethod\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CaptureFrequency\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"CombinedAttachments\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ComplianceStatus\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"ContentDocumentLinks\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ContractLineItem\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ContractLineItem\"/>\n        <element name=\"ContractLineItemId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\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=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"EndDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"NextDataCaptureDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\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=\"OutcomeCaptures\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\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=\"ProcessInstances\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"ProcessSteps\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"RecordsetFilterCriteria\" nillable=\"true\" minOccurs=\"0\" type=\"ens:RecordsetFilterCriteria\"/>\n        <element name=\"RecordsetFilterCriteriaId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"ServiceContract\" nillable=\"true\" minOccurs=\"0\" type=\"ens:ServiceContract\"/>\n        <element name=\"ServiceContractId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"Shares\" nillable=\"true\" minOccurs=\"0\" type=\"tns:QueryResult\"/>\n        <element name=\"StartDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"UserRecordAccess\" nillable=\"true\" minOccurs=\"0\" type=\"ens:UserRecordAccess\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n<simpleType name=\"QueryLocator\">\n  <restriction base=\"xsd:string\"/>\n</simpleType>\n<complexType name=\"QueryResult\">\n  <sequence>\n    <element name=\"done\" type=\"xsd:boolean\"/>\n    <element name=\"queryLocator\" type=\"tns:QueryLocator\" nillable=\"true\"/>\n    <element name=\"records\" type=\"ens:sObject\" nillable=\"true\" minOccurs=\"0\" maxOccurs=\"unbounded\"/>\n    <element name=\"size\" type=\"xsd:int\"/>\n  </sequence>\n</complexType>\n```",
  "field_reference": {
    "CalculationMethod": {
      "field_label": "Calculation Method",
      "type": "picklist",
      "length": "255"
    },
    "CaptureFrequency": {
      "field_label": "Capture Frequency",
      "type": "picklist",
      "length": "255"
    },
    "ComplianceStatus": {
      "field_label": "Compliance Status",
      "type": "picklist",
      "length": "255"
    },
    "ContractLineItemId": {
      "field_label": "Contract Line Item ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "CurrencyIsoCode": {
      "field_label": "Currency ISO Code",
      "type": "picklist",
      "length": "3"
    },
    "Description": {
      "field_label": "Description",
      "type": "textarea",
      "length": "32000"
    },
    "EndDate": {
      "field_label": "End Date",
      "type": "datetime"
    },
    "Id": {
      "field_label": "Contract Line Outcome ID",
      "type": "id",
      "length": "18"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "LastReferencedDate": {
      "field_label": "Last Referenced Date",
      "type": "datetime"
    },
    "LastViewedDate": {
      "field_label": "Last Viewed Date",
      "type": "datetime"
    },
    "Name": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "NextDataCaptureDate": {
      "field_label": "Next Data Capture Date",
      "type": "datetime"
    },
    "OwnerId": {
      "field_label": "Owner ID",
      "type": "reference",
      "length": "18"
    },
    "RecordsetFilterCriteriaId": {
      "field_label": "Recordset Filter Criteria ID",
      "type": "reference",
      "length": "18"
    },
    "ServiceContractId": {
      "field_label": "Service Contract ID",
      "type": "reference",
      "length": "18"
    },
    "StartDate": {
      "field_label": "Start Date",
      "type": "datetime"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length"
  ]
}