Get Source Code Group

Retrieve source code group information.

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

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Source Code Group action (under Source Code Groups (Data API)).
Fill in the fields below, then reference the result from later steps as {{getSourceCodeGroup.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

idstringrequired

The ID of the source code group

Query parameters

siteIdstringrequired

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.

Response

Returns 200 with an object. Read it in later steps with {{getSourceCodeGroup.response.data.<field>}}.

activeboolean

The active flag, a computed value based on start and end time.

activeRedirectany

The active redirect information.

cookieDurationinteger (int32)

The cookie duration in days.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

descriptionstring

The description.

enabledboolean

The enabled flag for storefront to consider the source code group, default to false.

endTimestring (date-time)

The end time.

idstring

The ID of source code group.

inactiveRedirectany

The inactive redirect information.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

specificationsarray<object>

Source code specifications.

expressionstringrequired

Expression is a value for the "Source Code Specification" may be literal source code, or it may contain wildcards. Literal code is simply the literal code. Valid characters are letters and numbers (no spaces). A wildcard allows a single source code specification to match multiple source codes. The following wildcards are supported: * ? - Matches any single alpha-numeric character. For example: the source code specification 'ABC?' would match 'ABCD' or 'ABC3', but not 'ABCDE'. * \* - Matches any sequence of alpha-numeric characters. For example: the source code specification 'ABC*' would match 'ABCD', 'ABCDE', or 'ABC123'. * [n1..n2] - Matches any number from n1 through and including n2. For example: the source code specification 'ABC[3..22]' would match 'ABC3', 'ABC4' or 'ABC22', but not 'ABC33' or 'ABCD'.

startTimestring (date-time)

The start time.

json

{
  "id": "TV-Email",
  "active": true,
  "activeRedirect": null,
  "cookieDuration": 25,
  "creationDate": "2019-10-20T12:00:00Z",
  "description": "This source code group is used to email promoting Flat Screen Television.\n",
  "enabled": false,
  "endTime": "2019-11-20T12:00:00Z",
  "inactiveRedirect": null,
  "lastModified": "2019-10-20T12:00:00Z",
  "specifications": [
    {
      "expression": "televisions[1..10000]"
    }
  ],
  "startTime": "2019-10-20T12:00:00Z"
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?