Jump to

• Request
• Response

Create a conversation reference

post

/crmRestApi/resources/11.13.18.05/conversations/{ConversationNumber}/child/conversationReferences

Request

Path Parameters

• ConversationNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConversationId: integer (int64)
  Title: Conversation ID

  The unique identifier of the conversation with which the business object is associated.
• ConversationNumber: string
  Title: Conversation Number

  Maximum Length: 30

  The alternate key identifier of the conversation with which the business object is associated.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the business object associated with the conversation.
• ObjectNumber: string
  Title: Object Number

  Maximum Length: 255

  The alternate key identifier of the business object associated with the conversation.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.
• ReferenceNumber: string
  Title: Reference Number

  Maximum Length: 30

  The public unique identifier of the conversation reference.

{
    "type":"object",
    "properties":{
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the conversation with which the business object is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectNumber":{
            "title":"Object Number",
            "maxLength":"255",
            "type":"string",
            "description":"The alternate key identifier of the business object associated with the conversation.",
            "nullable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the business object associated with the conversation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the conversation with which the business object is associated.",
            "nullable":false
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the conversation reference.",
            "nullable":false
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : conversations-conversationReferences-item-response

Type: object

Show Source

• ConversationId: integer (int64)
  Title: Conversation ID

  The unique identifier of the conversation with which the business object is associated.
• ConversationNumber: string
  Title: Conversation Number

  Maximum Length: 30

  The alternate key identifier of the conversation with which the business object is associated.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the conversation reference.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the conversation reference was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the conversation reference was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the conversation reference.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the conversation reference.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the business object associated with the conversation.
• ObjectNumber: string
  Title: Object Number

  Maximum Length: 255

  The alternate key identifier of the business object associated with the conversation.
• ObjectTypeCd: string
  Title: Object Type

  Maximum Length: 30

  The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.
• ObjectTypeCdMeaning: string
  Title: Object Type

  Read Only: true

  Maximum Length: 255

  The object type, such as Opportunity, Service Request, Activity, Sales Lead or Account.
• ReferenceId: integer (int64)
  Title: Reference ID

  Read Only: true

  The unique identifier of the conversation reference.
• ReferenceNumber: string
  Title: Reference Number

  Maximum Length: 30

  The public unique identifier of the conversation reference.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the conversation reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the conversation reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of the conversation with which the business object is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the conversation reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectNumber":{
            "title":"Object Number",
            "maxLength":"255",
            "type":"string",
            "description":"The alternate key identifier of the business object associated with the conversation.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the business object associated with the conversation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the conversation reference.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCdMeaning":{
            "title":"Object Type",
            "maxLength":"255",
            "type":"string",
            "description":"The object type, such as Opportunity, Service Request, Activity, Sales Lead or Account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ObjectTypeCd"
                ]
            },
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"The unique identifier of the conversation reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConversationNumber":{
            "title":"Conversation Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the conversation with which the business object is associated.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the conversation reference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the conversation reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ObjectTypeCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_MC_OBJECT_TYPE_CD

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectTypeCd; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top