|
Topics: |
Use the following REST call to return detailed metadata for a subject instance. See the data dictionary for the metadata repository for an explanation of the attributes returned.
|
Topics: |
The response is returned in JSON format. {name} is the name of a subject instance in the project.
GET https://localhost:9500/api/v1/metadata/subject/instance/SalesOrg
-- response --
{
"status": "OK",
"code": 0,
"message": null,
"developerMessage": null,
"responseType": "com.ibi.omni.model.ids.IdsDocumentModel",
"response": {
"name": "SalesOrg",
"version": null,
"bundleCreatedBy": "IBI Deployment Bundler",
"projectName": "CustomerAutoiwqaomnia",
"bundleReleaseNumber": "3.5.0.Alpha.10",
"bundleVersion": "CustomerAutoiwqaomnia_3_5_0_Alpha_10_190506131145",
"idsVersion": "2.0",
"udlName": "SalesOrg",
"type": "instance",
"master": "SalesOrgMaster",
"instance": null,
"access": "standard",
"tableName": "og_sales_org",
"sourceTableName": "og_sales_org_s",
"rampTableName": "og_sales_org_r",
"tableSpace": null,
"domain": "SalesOrg",
"elementOrder": "OmniStatus,OmniStatusReason,SourceName,SourceInstanceId,SourceInstanceIdName,MasterId,sales_org_name,sales_org_desc,sales_org_start_dt,sales_org_end_dt,primary_geo_area,SourceStatusCode,SourceCreatedDate,SourceCreatedBy,SourceModifiedDate,SourceModifiedBy",
"captureHistory": false,
"excludeFromRamp": false,
"backingClass": "com.ibi.omni.model.DIBMasteredInstance",
"implementationClass": null,
"allowInitialUpdates": false,
"persistenceUnit": null,
"cleanse": true,
"match": true,
"merge": false,
"remediate": false,
"system": false,
"documentation": "The enterprise's sales organization information such as name, identifier and description.",
"longDocumentation": "",
"changeLogs": [],
"elements": [
{
"name": "sales_org_desc",
"udlName": "sales_org_desc",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "sales_org_desc",
"dbRampColumns": null, "contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": false,
"merge": true,
"remediate": false,
"system": false,
"documentation": "The textual description for a sales organization.",
"shortDescription": null
},
{
"name": "SourceStatusCode",
"udlName": "sourceStatusCode",
"typeName": "code",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_status_code_code",
"dbRampColumns": "source_status_code_src,source_status_code_set,source_status_code_val",
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": false, "documentation": "Use this element to specify a customer specific status for the instance. This may be used during the match and merge process.",
"shortDescription": null
},
{
"name": "SourceName",
"udlName": "sourceName",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_name",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": true,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "This element must identify the source system that was responsible for generating this data. This value is determined by the integration team and used in combination with SourceInstanceId will allow this record to be traced back to its originating source.",
"shortDescription": null
},
{
"name": "SourceCreatedDate",
"udlName": "sourceCreatedDate",
"typeName": "datetime",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_created_date",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false, "index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use this element to define when this element was modified outside of Omni.",
"shortDescription": null
},
{
"name": "primary_geo_area",
"udlName": "primary_geo_area",
"typeName": "code",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "primary_geo_area_code",
"dbRampColumns": "primary_geo_area_src,primary_geo_area_set,primary_geo_area_val",
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false, "system": false,
"documentation": "The primary geographical area assigned to a sales organization.",
"shortDescription": null
},
{
"name": "SourceModifiedDate",
"udlName": "sourceModifiedDate",
"typeName": "datetime",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_modified_date",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use this element to define when this element was modified outside of Omni.",
"shortDescription": null
},
{
"name": "SourceInstanceId",
"udlName": "sourceInstanceId",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_instance_id",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": true,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true, "maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "This element should contain an integration manufactured value that uniquely identifies the collection element and can be used to map back to the source system. Whatever value is manufactured must not change over time as it will be used to make updates when data changes in the source system.",
"shortDescription": null
},
{
"name": "SourceCreatedBy",
"udlName": "sourceCreatedBy",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_created_by",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use this element to define the id of the person who was responsible for creating data for this record.",
"shortDescription": null
},
{
"name": "SourceInstanceIdName",
"udlName": "sourceInstanceIdName",
"typeName": "string",
"dbTable": "og_sales_org", "sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_instance_id_name",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "This element gives an indication of where the data came from in the source system. Will be used in the 360 viewer for stewards to trace data from Omni back into the source system.",
"shortDescription": null
},
{
"name": "sales_org_start_dt",
"udlName": "sales_org_start_dt",
"typeName": "date",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "sales_org_start_dt",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": false, "merge": true,
"remediate": false,
"system": false,
"documentation": "The start date for a sales organization.",
"shortDescription": null
},
{
"name": "SourceModifiedBy",
"udlName": "sourceModifiedBy",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "source_modified_by",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use this element to define the id of the person who was responsible for modifying data for this record.",
"shortDescription": null
},
{
"name": "OmniStatus",
"udlName": "omniStatus",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "status",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": true,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use this element to set the status of this record. This field will default to 'ACTIVE' if not supplied. Possible values are: 'ACTIVE', 'INACTIVE', 'MERGED', 'LINKED', 'UNLINK'",
"shortDescription": null
},
{
"name": "sales_org_name",
"udlName": "sales_org_name",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "sales_org_name",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": false,
"documentation": "The textual name for a sales organization.",
"shortDescription": null
},
{
"name": "OmniStatusReason",
"udlName": "omniStatusReason",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s", "rampTable": "og_sales_org_r",
"dbColumn": "status_reason",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": true,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Use to specify the reason for the status.",
"shortDescription": null
},
{
"name": "sales_org_end_dt",
"udlName": "sales_org_end_dt",
"typeName": "date",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "sales_org_end_dt",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": false,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": true,
"match": false, "merge": true,
"remediate": false,
"system": false,
"documentation": "The end date for a sales organization.",
"shortDescription": null
},
{
"name": "MasterId",
"udlName": "masterId",
"typeName": "string",
"dbTable": "og_sales_org",
"sourceTable": "og_sales_org_s",
"rampTable": "og_sales_org_r",
"dbColumn": "master_id",
"dbRampColumns": null,
"contains": null,
"keys": null,
"immediate": false,
"hidden": true,
"key": false,
"excludeInDoc": false,
"required": false,
"index": false,
"allowCreate": true,
"maxLength": null,
"precision": null,
"scale": null,
"excludeFromRamp": false,
"codeSourceName": null,
"codeSet": null,
"cleanse": false,
"match": true,
"merge": true,
"remediate": false,
"system": true,
"documentation": "Master id for master instance relationship.",
"shortDescription": null
}
],
"lists": [],
"groups": []
},
"exception": null
}