Jump to

• Request
• Response
• Examples

Get all source system references

get

/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a source system reference assignment by using the assignment record's primary key.
    Finder Variables:
    • SourceSystemReferenceId; integer; The unique identifier of the source system reference assignment.
  • SSRById: Finds a source system reference assignment by using the assignment record's identifier.
    Finder Variables:
    • SourceSystemReferenceId; integer; The unique identifier of the source system reference assignment.
  • SSRByOsOsrOwnerEntityObject: Finds a source system reference assignment by using the source system reference and trading community object name.
    Finder Variables:
    • OwnerEntityObject; string; The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT.
    • SourceSystem; string; The name of the source system.
    • SourceSystemReferenceValue; string; The source system id for the source system logical entity.
  • SSRByOsOsrOwnerEntityObjectId: Finds a source system reference assignment by using the source system reference and trading community object record identifier values.
    Finder Variables:
    • OwnerEntityId; integer; The fusion identifier for a record in owner entity object for which new source system, or source system reference are associated. It can be provided in case of insert.
    • OwnerEntityObject; string; The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT.
    • SourceSystem; string; The name of the source system.
    • SourceSystemReferenceValue; string; The source system id for the source system logical entity.
  • SourceSystemReferenceAltKey: Finds a source system reference assignment by using the assignment record's alternate key source system, source system reference value, or owner entity object.
    Finder Variables:
    • OwnerEntityObject; string.
    • SourceSystem; string.
    • SourceSystemReferenceValue; string.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Attribute1; string; Stores the value in the column for the flexfield mapped to character column 1.
  • Attribute10; string; Stores the value in the column for the flexfield mapped to character column 10.
  • Attribute11; string; Stores the value in the column for the flexfield mapped to character column 11.
  • Attribute12; string; Stores the value in the column for the flexfield mapped to character column 12.
  • Attribute13; string; Stores the value in the column for the flexfield mapped to character column 13.
  • Attribute14; string; Stores the value in the column for the flexfield mapped to character column 14.
  • Attribute15; string; Stores the value in the column for the flexfield mapped to character column 15.
  • Attribute16; string; Stores the value in the column for the flexfield mapped to character column 16.
  • Attribute17; string; Stores the value in the column for the flexfield mapped to character column 17.
  • Attribute18; string; Stores the value in the column for the flexfield mapped to character column 18.
  • Attribute19; string; Stores the value in the column for the flexfield mapped to character column 19.
  • Attribute2; string; Stores the value in the column for the flexfield mapped to character column 2.
  • Attribute20; string; Stores the value in the column for the flexfield mapped to character column 20.
  • Attribute21; string; Stores the value in the column for the flexfield mapped to character column 21.
  • Attribute22; string; Stores the value in the column for the flexfield mapped to character column 22.
  • Attribute23; string; Stores the value in the column for the flexfield mapped to character column 23.
  • Attribute24; string; Stores the value in the column for the flexfield mapped to character column 24.
  • Attribute25; string; Stores the value in the column for the flexfield mapped to character column 25.
  • Attribute26; string; Stores the value in the column for the flexfield mapped to character column 26.
  • Attribute27; string; Stores the value in the column for the flexfield mapped to character column 27.
  • Attribute28; string; Stores the value in the column for the flexfield mapped to character column 28.
  • Attribute29; string; Stores the value in the column for the flexfield mapped to character column 29.
  • Attribute3; string; Stores the value in the column for the flexfield mapped to character column 3.
  • Attribute30; string; Stores the value in the column for the flexfield mapped to character column 30.
  • Attribute4; string; Stores the value in the column for the flexfield mapped to character column 4.
  • Attribute5; string; Stores the value in the column for the flexfield mapped to character column 5.
  • Attribute6; string; Stores the value in the column for the flexfield mapped to character column 6.
  • Attribute7; string; Stores the value in the column for the flexfield mapped to character column 7.
  • Attribute8; string; Stores the value in the column for the flexfield mapped to character column 8.
  • Attribute9; string; Stores the value in the column for the flexfield mapped to character column 9.
  • AttributeCategory; string; The attribute stores the category value for a group of flexfields.
  • AttributeDate1; string; Stores the value in the column for the flexfield mapped to date column 1.
  • AttributeDate10; string; Stores the value in the column for the flexfield mapped to date column 10.
  • AttributeDate11; string; Stores the value in the column for the flexfield mapped to date column 11.
  • AttributeDate12; string; Stores the value in the column for the flexfield mapped to date column 12.
  • AttributeDate2; string; Stores the value in the column for the flexfield mapped to date column 2.
  • AttributeDate3; string; Stores the value in the column for the flexfield mapped to date column 3.
  • AttributeDate4; string; Stores the value in the column for the flexfield mapped to date column 4.
  • AttributeDate5; string; Stores the value in the column for the flexfield mapped to date column 5.
  • AttributeDate6; string; Stores the value in the column for the flexfield mapped to date column 6.
  • AttributeDate7; string; Stores the value in the column for the flexfield mapped to date column 7.
  • AttributeDate8; string; Stores the value in the column for the flexfield mapped to date column 8.
  • AttributeDate9; string; Stores the value in the column for the flexfield mapped to date column 9.
  • AttributeNumber1; number; Stores the value in the column for the flexfield mapped to number column 1.
  • AttributeNumber10; number; Stores the value in the column for the flexfield mapped to number column 10.
  • AttributeNumber11; number; Stores the value in the column for the flexfield mapped to number column 11.
  • AttributeNumber12; number; Stores the value in the column for the flexfield mapped to number column 12.
  • AttributeNumber2; number; Stores the value in the column for the flexfield mapped to number column 2.
  • AttributeNumber3; number; Stores the value in the column for the flexfield mapped to number column 3.
  • AttributeNumber4; number; Stores the value in the column for the flexfield mapped to number column 4.
  • AttributeNumber5; number; Stores the value in the column for the flexfield mapped to number column 5.
  • AttributeNumber6; number; Stores the value in the column for the flexfield mapped to number column 6.
  • AttributeNumber7; number; Stores the value in the column for the flexfield mapped to number column 7.
  • AttributeNumber8; number; Stores the value in the column for the flexfield mapped to number column 8.
  • AttributeNumber9; number; Stores the value in the column for the flexfield mapped to number column 9.
  • CreatedBy; string; The user who created the row.
  • CreatedByModule; string; The module that created the source system reference.
  • CreationDate; string; The date and time when the row was created.
  • EndDateActive; string; The end date of the source system reference. This cannot be a past date.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the row.
  • LastUpdatedBy; string; The user who last updated the row.
  • OwnerEntityId; integer; The fusion identifier for a record in owner entity object for which new source system, source system reference are associated. It can be provided in case of insert.
  • OwnerEntityObject; string; The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT.
  • ReasonCode; string; This is validated against the MOSR_REASON lookup type.
  • SourceSystem; string; The source system name. Provide it in case of insert.
  • SourceSystemReferenceId; integer; The sequentially generated primary key.
  • SourceSystemReferenceValue; string; The source system id for the source system logical entity. Provide it in case of insert.
  • StartDateActive; string; The start date of the source system reference. This cannot be a future date.
  • Status; string; The status of the source system reference. Valid values are Active - 'A' and Inactive - 'I'.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : hubSourceSystemReferences

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hubSourceSystemReferences-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hubSourceSystemReferences-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hubSourceSystemReferences-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 : hubSourceSystemReferences-item-response

Type: object

Show Source

• Attribute1: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 1.
• Attribute10: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 10.
• Attribute11: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 11.
• Attribute12: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 12.
• Attribute13: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 13.
• Attribute14: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 14.
• Attribute15: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 15.
• Attribute16: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 16.
• Attribute17: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 17.
• Attribute18: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 18.
• Attribute19: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 19.
• Attribute2: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 2.
• Attribute20: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 20.
• Attribute21: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 21.
• Attribute22: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 22.
• Attribute23: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 23.
• Attribute24: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 24.
• Attribute25: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 25.
• Attribute26: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 26.
• Attribute27: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 27.
• Attribute28: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 28.
• Attribute29: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 29.
• Attribute3: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 3.
• Attribute30: string
  Maximum Length: 255

  Stores the value in the column for the flexfield mapped to character column 30.
• Attribute4: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 4.
• Attribute5: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 5.
• Attribute6: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 6.
• Attribute7: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 7.
• Attribute8: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 8.
• Attribute9: string
  Maximum Length: 150

  Stores the value in the column for the flexfield mapped to character column 9.
• AttributeCategory: string
  Maximum Length: 30

  The attribute stores the category value for a group of flexfields.
• AttributeDate1: string (date)
  Stores the value in the column for the flexfield mapped to date column 1.
• AttributeDate10: string (date)
  Stores the value in the column for the flexfield mapped to date column 10.
• AttributeDate11: string (date)
  Stores the value in the column for the flexfield mapped to date column 11.
• AttributeDate12: string (date)
  Stores the value in the column for the flexfield mapped to date column 12.
• AttributeDate2: string (date)
  Stores the value in the column for the flexfield mapped to date column 2.
• AttributeDate3: string (date)
  Stores the value in the column for the flexfield mapped to date column 3.
• AttributeDate4: string (date)
  Stores the value in the column for the flexfield mapped to date column 4.
• AttributeDate5: string (date)
  Stores the value in the column for the flexfield mapped to date column 5.
• AttributeDate6: string (date)
  Stores the value in the column for the flexfield mapped to date column 6.
• AttributeDate7: string (date)
  Stores the value in the column for the flexfield mapped to date column 7.
• AttributeDate8: string (date)
  Stores the value in the column for the flexfield mapped to date column 8.
• AttributeDate9: string (date)
  Stores the value in the column for the flexfield mapped to date column 9.
• AttributeNumber1: number
  Stores the value in the column for the flexfield mapped to number column 1.
• AttributeNumber10: number
  Stores the value in the column for the flexfield mapped to number column 10.
• AttributeNumber11: number
  Stores the value in the column for the flexfield mapped to number column 11.
• AttributeNumber12: number
  Stores the value in the column for the flexfield mapped to number column 12.
• AttributeNumber2: number
  Stores the value in the column for the flexfield mapped to number column 2.
• AttributeNumber3: number
  Stores the value in the column for the flexfield mapped to number column 3.
• AttributeNumber4: number
  Stores the value in the column for the flexfield mapped to number column 4.
• AttributeNumber5: number
  Stores the value in the column for the flexfield mapped to number column 5.
• AttributeNumber6: number
  Stores the value in the column for the flexfield mapped to number column 6.
• AttributeNumber7: number
  Stores the value in the column for the flexfield mapped to number column 7.
• AttributeNumber8: number
  Stores the value in the column for the flexfield mapped to number column 8.
• AttributeNumber9: number
  Stores the value in the column for the flexfield mapped to number column 9.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreatedByModule: string
  Maximum Length: 30

  Default Value: ORA_ZCH_WS

  The module that created the source system reference.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• EndDateActive: string (date)
  The end date of the source system reference. This cannot be a past date.
• ExistingSourceSystem: string
  The referenced source system that already exists in the OSR base table. Can be provided in case of insert.
• ExistingSourceSystemReferenceValue: string
  The referenced source system reference that already exists in the OSR base table. It can be provided in case of insert. The existing source system and existing source system reference are used to identify the fusion identifier for which new source system reference is to be created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• OwnerEntityId: integer (int64)
  The fusion identifier for a record in owner entity object for which new source system, source system reference are associated. It can be provided in case of insert.
• OwnerEntityObject: string
  Maximum Length: 30

  The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT.
• ReasonCode: string
  Maximum Length: 30

  This is validated against the MOSR_REASON lookup type.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  The source system name. Provide it in case of insert.
• SourceSystemReferenceId: integer (int64)
  Read Only: true

  The sequentially generated primary key.
• SourceSystemReferenceValue: string
  Maximum Length: 255

  The source system id for the source system logical entity. Provide it in case of insert.
• StartDateActive: string (date)
  The start date of the source system reference. This cannot be a future date.
• Status: string
  Read Only: true

  Maximum Length: 1

  Default Value: A

  The status of the source system reference. Valid values are Active - 'A' and Inactive - 'I'.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExistingSourceSystem":{
            "type":"string",
            "description":"The referenced source system that already exists in the OSR base table. Can be provided in case of insert.",
            "nullable":true,
            "x-queryable":false
        },
        "ExistingSourceSystemReferenceValue":{
            "type":"string",
            "description":"The referenced source system reference that already exists in the OSR base table. It can be provided in case of insert. The existing source system and existing source system reference are used to identify the fusion identifier for which new source system reference is to be created.",
            "nullable":true,
            "x-queryable":false
        },
        "AttributeNumber12":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 12.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeNumber11":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 11.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber10":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 10.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "maxLength":"30",
            "type":"string",
            "description":"The module that created the source system reference.",
            "nullable":true,
            "default":"ORA_ZCH_WS",
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"The status of the source system reference. Valid values are Active - 'A'  and Inactive - 'I'.",
            "nullable":false,
            "readOnly":true,
            "default":"A",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Attribute30":{
            "maxLength":"255",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 30.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerEntityObject":{
            "maxLength":"30",
            "type":"string",
            "description":"The TCA entity that holds the fusion identifier, for which new source system, source system reference are associated. Valid values are lookup-code of lookup type ORA_ZCH_OWNER_ENTITY_OBJECT.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"This is validated against the MOSR_REASON lookup type.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute27":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 27.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute26":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 26.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The end date of the source system reference. This cannot be a past date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Attribute29":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 29.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute28":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 28.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate10":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 10.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate12":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 12.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDate11":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 11.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute9":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 9.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute8":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 8.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceId":{
            "type":"integer",
            "description":"The sequentially generated primary key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Attribute7":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 7.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute6":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 6.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute5":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 5.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute4":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 4.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute stores the category value for a group of flexfields.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute3":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 3.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute2":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 2.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute1":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 1.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute21":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 21.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute20":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 20.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute23":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 23.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute22":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 22.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute25":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 25.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute24":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 24.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute16":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 16.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The start date of the source system reference. This cannot be a future date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Attribute15":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 15.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute18":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 18.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute17":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 17.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute19":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 19.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerEntityId":{
            "type":"integer",
            "description":"The fusion identifier for a record in owner entity object for which new source system, source system reference are associated. It can be provided in case of insert.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeNumber8":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 8.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber7":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 7.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute10":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 10.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber6":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 6.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber5":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 5.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute12":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 12.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute11":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 11.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The source system id for the source system logical entity. Provide it in case of insert.",
            "nullable":false,
            "x-queryable":true
        },
        "Attribute14":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 14.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute13":{
            "maxLength":"150",
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to character column 13.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber9":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 9.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate3":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 3.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate2":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 2.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate5":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 5.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate4":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 4.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber4":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 4.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate7":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 7.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber3":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 3.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate6":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 6.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber2":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 2.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate9":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 9.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber1":{
            "type":"number",
            "description":"Stores the value in the column for the flexfield mapped to number column 1.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate8":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 8.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"The source system name. Provide it in case of insert.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeDate1":{
            "type":"string",
            "description":"Stores the value in the column for the flexfield mapped to date column 1.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

Back to Top

Examples

The following example shows how to get all source system references by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -user sales_cloud_user -X GET  https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "SourceSystemReferenceId": 10766,
            "SourceSystem": "Pinnacle_Data",
            "SourceSystemReferenceValue": "1393",
            "OwnerEntityObject": "ORA_CUST_ACCT_SITES_ALL",
            "OwnerEntityId": 1394,
            "ExistingSourceSystem": null,
            "ExistingSourceSystemReferenceValue": null,
            "StartDateActive": "2004-02-23",
            "EndDateActive": "4712-12-31",
            "Status": "A",
            "ReasonCode": null,
            "CreatedBy": "2045",
            "CreationDate": "1999-10-06T03:54:14+00:00",
            "LastUpdatedBy": "2045",
            "LastUpdateDate": "1999-10-06T03:54:14+00:00",
            "LastUpdateLogin": "357171",
            "CreatedByModule": "TCA",
            "AttributeCategory": null,
            "Attribute1": null,
            ...
            "AttributeDate1": null,
            "AttributeDate2": null,
            "AttributeDate3": null,
            "AttributeDate4": null,
            "AttributeDate5": null,
            "AttributeDate6": null,
            "AttributeDate7": null,
            "AttributeDate8": null,
            "AttributeDate9": null,
            "AttributeDate10": null,
            "AttributeDate11": null,
            "AttributeDate12": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766",
                    "name": "hubSourceSystemReferences",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A61766176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766",
                    "name": "hubSourceSystemReferences",
                    "kind": "item"
                }
            ]
        },
...
}

Back to Top