Jump to

• Request
• Response
• Examples

Update a bulk export activity child object detail

patch

/crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}

Request

Path Parameters

• BulkExportJobId(required): integer(int64)
  The unique identifier of the export job.
• ExportObject(required): string
  The name of the object that is exported.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• childBulkExportActivity: array Export Child Object Activities
  Title: Export Child Object Activities

  The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
• ExportColumnNames: string
  Title: Export Column Names

  The object columns that are exported.
• ExportFilterCriteria: string
  Title: Export Filter Criteria

  Maximum Length: 4000

  The export object filter criteria specifying which records will be exported.
• ExportObject(required): string
  Title: Object Code

  Maximum Length: 128

  The name of the object that is exported.
• ExportOrderBy: string
  Title: Order By

  Maximum Length: 1000

  The order of the columns in the exported file.
• ExportParentObject: string
  Title: Export Parent Object

  Maximum Length: 128

  The name of the parent object that is exported.

{
    "required":[
        "ExportObject"
    ],
    "type":"object",
    "properties":{
        "ExportObject":{
            "title":"Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":"1000",
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true
        },
        "childBulkExportActivity":{
            "title":"Export Child Object Activities",
            "type":"array",
            "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-patch-request"
            }
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":"4000",
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true
        }
    }
}

Nested Schema : Export Child Object Activities

Type: array

Title: Export Child Object Activities

The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.

Show Source

• Array of: object bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-patch-request

{
    "title":"Export Child Object Activities",
    "type":"array",
    "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-patch-request"
    }
}

Nested Schema : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-patch-request

Type: object

Show Source

• ExportColumnNames: string
  Title: Export Column Names

  The object columns that are exported.
• ExportFilterCriteria: string
  Title: Export Filter Criteria

  Maximum Length: 4000

  The export object filter criteria specifying which records will be exported.
• ExportObject: string
  Title: Object Code

  Maximum Length: 128

  The name of the object that is exported.
• ExportOrderBy: string
  Title: Order By

  Maximum Length: 1000

  The order of the columns in the exported file.
• ExportParentObject: string
  Title: Export Parent Object

  Maximum Length: 128

  The name of the parent object that is exported.

{
    "type":"object",
    "properties":{
        "ExportObject":{
            "title":"Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":"1000",
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":"4000",
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true
        }
    }
}

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 : bulkExportActivities-childBulkExportActivity-item-response

Type: object

Show Source

• childBulkExportActivity: array Export Child Object Activities
  Title: Export Child Object Activities

  The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the record was created.
• ExportColumnNames: string
  Title: Export Column Names

  The object columns that are exported.
• ExportFilterCriteria: string
  Title: Export Filter Criteria

  Maximum Length: 4000

  The export object filter criteria specifying which records will be exported.
• ExportObject: string
  Title: Object Code

  Maximum Length: 128

  The name of the object that is exported.
• ExportOrderBy: string
  Title: Order By

  Maximum Length: 1000

  The order of the columns in the exported file.
• ExportParentObject: string
  Title: Export Parent Object

  Maximum Length: 128

  The name of the parent object that is exported.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordsExported: string
  Title: Records Exported

  Read Only: true

  The total number of records exported.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":"1000",
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true,
            "x-queryable":true
        },
        "childBulkExportActivity":{
            "title":"Export Child Object Activities",
            "type":"array",
            "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response"
            }
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "nullable":true,
            "readOnly":true,
            "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 Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":"4000",
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Export Child Object Activities

Type: array

Title: Export Child Object Activities

The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.

Show Source

• Array of: object bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response

{
    "title":"Export Child Object Activities",
    "type":"array",
    "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response"
    }
}

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 : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the record was created.
• ExportColumnNames: string
  Title: Export Column Names

  The object columns that are exported.
• ExportFilterCriteria: string
  Title: Export Filter Criteria

  Maximum Length: 4000

  The export object filter criteria specifying which records will be exported.
• ExportObject: string
  Title: Object Code

  Maximum Length: 128

  The name of the object that is exported.
• ExportOrderBy: string
  Title: Order By

  Maximum Length: 1000

  The order of the columns in the exported file.
• ExportParentObject: string
  Title: Export Parent Object

  Maximum Length: 128

  The name of the parent object that is exported.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordsExported: string
  Title: Records Exported

  Read Only: true

  The total number of records exported.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":"1000",
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "nullable":true,
            "readOnly":true,
            "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 Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":"128",
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":"4000",
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":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

childBulkExportActivity

Operation: /crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}/child/childBulkExportActivity/{ExportObject}/child/childBulkExportActivity

Parameters:

• BulkExportJobId: $request.path.BulkExportJobId
• ExportObject: $request.path.ExportObject

The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.

Back to Top

Examples

The following example shows how to update a bulk export activity child object detail by submitting a PATCH request on the REST resource using cURL.

Note:

Depending on the object being exported, you can export hierarchy trees with multiple levels using the child bulk export activities resource. Using this resource, you can export the complete hierarchy, including multiple levels of hierarchical children, recursively within the parent object.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100125069284/child/childBulkExportActivity/ActivityAssignee

Example of Request Body

The following shows an example of the request body in JSON format.

{
"ExportObject": "ActivityObjectives",
"ExportParentObject": "Activity"
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "ExportObject" : "ActivityObjectives",
  "ExportParentObject" : "Activity",
  "ExportColumnNames" : "ActivityId,AssigneeId",
  "ExportFilterCriteria" : null,
  "ExportOrderBy" : null,
  "RecordsExported" : "",
  "CreatedBy" : "SALES_ADMIN",
  "CreationDate" : "2018-03-28T22:35:48.498+00:00",
  "LastUpdateDate" : "2018-03-30T13:38:42+00:00",
  "LastUpdateLogin" : "688D79ABD4837D17E053C30AF20A6190",
  "LastUpdatedBy" : "SALES_ADMIN",
  "links" : 
  ...,
}

Back to Top