Jump to

• Request
• Response

Advanced query an integration map

post

/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationMaps/{integrationMaps_id}/$query

Request

Path Parameters

• integrationMaps_id(required): string
  This path parameter maps to the following field defined in the Integration Maps REST resource:
  

  1. integrationMapNumber: The public unique identifier of the integration map.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accessors: object accessors
  Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
• fields: array fields
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• subTypes: object subTypes
  Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

{
    "type":"object",
    "properties":{
        "fields":{
            "type":"array",
            "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
            "items":{
                "type":"string"
            }
        },
        "subTypes":{
            "type":"object",
            "description":"Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base."
        },
        "accessors":{
            "type":"object",
            "description":"Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base."
        }
    }
}

Nested Schema : accessors

Type: object

Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.

Nested Schema : fields

Type: array

Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Restricts the resource fields. Only the specified fields and mandatory system fields are returned.",
    "items":{
        "type":"string"
    }
}

Nested Schema : subTypes

Type: object

Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.

Back to Top

Response

Default Response

A single item response

Body ()

Root Schema : integrationMaps_item-response

Match All

Show Source

• object Integration Map
  Title: Integration Map

  An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application.
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : Integration Map

Type: object

Title: Integration Map

An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application.

Show Source

• activeFlag: boolean
  Title: Active Flag

  Indicates that the integration map is active.
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the integration map record.
• description: string
  Title: Map Description

  The description of the integration map.
• integrationMapId: string (big-integer)
  Title: Integration Map Identifier

  The unique identifier of the integration map.
• integrationMapNumber: string
  Title: Integration Map Number

  The public unique identifier of the integration map.
• integrationSpec: string (long-text)
  Title: Map Transform Specification

  The transform specifications for the integration map.
• lockedFlag: boolean
  Title: Locked Flag

  Indicates that the integration map is locked and can't be edited or cloned by a user.
• name: string
  Title: Map Name

  The name of the integration map.
• seededFlag: boolean
  Title: Seeded Flag

  Indicates whether the integration map was seeded by Oracle.
• sourceApplication: string
  Title: Source Application

  Read Only: true

  The source application for the integration.
• sourceObject: string
  Title: Source Object

  The source object of the integration.
• timeCreated: string (date-time)
  Title: Time Created

  Read Only: true

  The date and time when the integration map was created.
• timeUpdated: string (date-time)
  Title: Time Updated

  Read Only: true

  The date and time when the integration map was last updated.
• updatedBy: string
  Title: Updated By

  Read Only: true

  The user who last updated the integration map record.

{
    "type":"object",
    "properties":{
        "integrationMapId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Identifier",
            "description":"The unique identifier of the integration map."
        },
        "name":{
            "type":"string",
            "title":"Map Name",
            "description":"The name of the integration map."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "title":"Map Description",
            "description":"The description of the integration map."
        },
        "integrationMapNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Number",
            "description":"The public unique identifier of the integration map."
        },
        "sourceApplication":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "title":"Source Application",
            "description":"The source application for the integration."
        },
        "sourceObject":{
            "type":"string",
            "x-searchable":true,
            "title":"Source Object",
            "description":"The source object of the integration."
        },
        "seededFlag":{
            "type":"boolean",
            "x-searchable":true,
            "title":"Seeded Flag",
            "description":"Indicates whether the integration map was seeded by Oracle."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time when the integration map was created."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration map record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration map was last updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who last updated the integration map record."
        },
        "integrationSpec":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Map Transform Specification",
            "description":"The transform specifications for the integration map."
        },
        "activeFlag":{
            "type":"boolean",
            "title":"Active Flag",
            "description":"Indicates that the integration map is active."
        },
        "lockedFlag":{
            "type":"boolean",
            "title":"Locked Flag",
            "description":"Indicates that the integration map is locked and can't be edited or cloned by a user."
        }
    },
    "x-primaryKey":[
        "integrationMapId"
    ],
    "x-alternateKeys":{
        "altKey":[
            "integrationMapNumber"
        ]
    },
    "title":"Integration Map",
    "x-hints":{
        "titlePlural":"Integration Maps"
    },
    "description":"An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application."
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Links

$self

Parameters:

• integrationMaps_id: $request.path.integrationMaps_id

Back to Top