Source Code Groups

GET Retrieve source code group information.

GET /organizations/{organizationId}/source-code-groups/{id}

Operation ID: getSourceCodeGroup. Security: AmOAuth2 (sfcc.source-codes, sfcc.source-codes.rw).

Parameters

• organizationId (path, OrganizationId, required) An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character realm identifier and a 3-character instance type identifier.

  Example

  f_ecom_zzxy_prd

• id (path, SourceCodeGroupId, required) The unique identifier of the source code group.
• siteId (query, SiteId, required) The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

  Example: SiteId

  RefArch

Responses

• 200 Source code group information returned successfully.

  Media type: application/json. Schema: SourceCodeGroup.

  Example: GetSourceCodeGroup

  {
    "active": false,
    "activeRedirect": {
      "location": "urlString",
      "locationType": "url"
    },
    "creationDate": "2019-11-25T15:24:25.317Z",
    "description": "description for source code group test2",
    "enabled": false,
    "endTime": "2030-10-01T00:00:00.000Z",
    "id": "20% off (£30) New Customer",
    "inactiveRedirect": {
      "location": "urlString",
      "locationType": "url"
    },
    "lastModified": "2019-11-25T15:28:55.175Z",
    "startTime": "2014-10-01T00:00:00.000Z"
  }

• 404 Returned when the source code group does not exist or does not match the given ID.

  Media type: application/json. Schema: ErrorResponse.

  Example: SourceCodeGroupNotFound404

  {
    "type": "SourceCodeGroupNotFoundException",
    "title": "Source Code Groups Not Found",
    "instance": "/sites/SiteGenesis/source_code_groups/foo",
    "detail": "No source code group with ID 'foo' for site 'SiteGenesis' could be found."
  }